Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui.common / src / org / simantics / browsing / ui / common / processors / IsExpandedProcessor.java

diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/processors/IsExpandedProcessor.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/processors/IsExpandedProcessor.java
new file mode 100644 (file)
index 0000000..9477f11
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/processors/IsExpandedProcessor.java
@@ -0,0 +1,57 @@
+/*******************************************************************************\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.common.processors;\r
+\r
+import java.util.Collection;\r
+\r
+import org.simantics.browsing.ui.GraphExplorer;\r
+import org.simantics.browsing.ui.NodeContext;\r
+\r
+/**\r
+ * @author Tuukka Lehtonen\r
+ */\r
+public interface IsExpandedProcessor {\r
+\r
+    /**\r
+     * @return all expanded nodes in the owner {@link GraphExplorer}\r
+     */\r
+    Collection<NodeContext> getExpanded();\r
+\r
+    /**\r
+     * @param context the context to test for expandedness\r
+     * @return <code>true</code> if expanded\r
+     */\r
+    boolean getExpanded(NodeContext context);\r
+\r
+    /**\r
+     * Set internal processor expanded status without notifying the graph\r
+     * explorer query cache of changes.\r
+     * \r
+     * @param context the context to mark as expanded\r
+     * @param expanded the new expanded state\r
+     * @return <code>true</code> if the node's expanded state was changed,\r
+     *         <code>false</code> otherwise\r
+     */\r
+    boolean setExpanded(NodeContext context, boolean expanded);\r
+\r
+    /**\r
+     * Replace the current processor expanded status and notify the graph\r
+     * explorer query cache of changes.\r
+     * \r
+     * @param context the context to mark as expanded\r
+     * @param expanded the new expanded state\r
+     * @return <code>true</code> if the node's expanded state was changed,\r
+     *         <code>false</code> otherwise\r
+     */\r
+    boolean replaceExpanded(NodeContext context, boolean expanded);\r
+\r
+}\r