Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui / src / org / simantics / browsing / ui / SelectionFilter.java

diff --git a/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/SelectionFilter.java b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/SelectionFilter.java
new file mode 100644 (file)
index 0000000..31454b0
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/SelectionFilter.java
@@ -0,0 +1,37 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.browsing.ui;\r
+\r
+/**\r
+ * A SelectionFilter gives a {@link GraphExplorer} client primitive control over\r
+ * what objects the explorer puts into the selections it provides.\r
+ * \r
+ * <p>\r
+ * Normally, a {@link GraphExplorer} selection contains only {@link NodeContext}\r
+ * instances which exist separately for each separate visible UI element, like a\r
+ * tree node. Presenting an implementation of this interface to an explorer will\r
+ * cause the explorer to filter its selected NodeContexts, one by one, through\r
+ * this interface.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ * \r
+ * @see GraphExplorer#setSelectionFilter(SelectionFilter)\r
+ */\r
+public interface SelectionFilter {\r
+\r
+    /**\r
+     * @param context the context to filter\r
+     * @return the filtered object\r
+     */\r
+    Object filter(NodeContext context);\r
+\r
+}\r