Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/processors/ShowMaxChildrenProcessor.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/processors/ShowMaxChildrenProcessor.java
new file mode 100644 (file)
index 0000000..ea00429
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/processors/ShowMaxChildrenProcessor.java
@@ -0,0 +1,51 @@
+/*******************************************************************************\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 org.simantics.browsing.ui.BuiltinKeys;\r
+import org.simantics.browsing.ui.NodeContext;\r
+import org.simantics.browsing.ui.PrimitiveQueryProcessor;\r
+\r
+/**\r
+ * A primitive query processor (see {@link PrimitiveQueryProcessor}) interface\r
+ * for externally controlling the results of\r
+ * {@link BuiltinKeys#SHOW_MAX_CHILDREN} queries.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public interface ShowMaxChildrenProcessor {\r
+\r
+    /**\r
+     * Set internal processor showAllChildren status without notifying the graph\r
+     * explorer query cache of changes.\r
+     * \r
+     * @param context the context to mark\r
+     * @param maxChildren the new max child count or 0 to make this processor\r
+     *        return <code>null</code> when queried\r
+     * @return <code>true</code> if the node's expanded state was changed,\r
+     *         <code>false</code> otherwise\r
+     */\r
+    boolean setShowMaxChildren(NodeContext context, int maxChildren);\r
+\r
+    /**\r
+     * Replace the current processor showAllChildren status and notify the graph\r
+     * explorer query cache of changes.\r
+     * \r
+     * @param context the context to mark\r
+     * @param maxChildren the new max child count or 0 to make this processor\r
+     *        return <code>null</code> when queried\r
+     * @return <code>true</code> if the node's expanded state was changed,\r
+     *         <code>false</code> otherwise\r
+     */\r
+    boolean replaceShowMaxChildren(NodeContext context, int maxChildren);\r
+\r
+}\r