Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/CheckedStateFactory.java b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/CheckedStateFactory.java
new file mode 100644 (file)
index 0000000..58de9ad
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/CheckedStateFactory.java
@@ -0,0 +1,46 @@
+/*******************************************************************************\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.content;\r
+\r
+import org.simantics.browsing.ui.CheckedState;\r
+import org.simantics.browsing.ui.NodeContext;\r
+import org.simantics.browsing.ui.PrimitiveQueryUpdater;\r
+import org.simantics.browsing.ui.BuiltinKeys.CheckedStateKey;\r
+\r
+/**\r
+ * A CheckState is used with check box trees (see SWT.CHECK). CheckStates are\r
+ * created by {@link CheckedStateFactory}s.\r
+ * \r
+ * @author Antti Villberg\r
+ * \r
+ */\r
+public interface CheckedStateFactory {\r
+\r
+    /**\r
+     * Returns a {@link CheckedState} for the specified input node context or\r
+     * <code>null</code> if this factory is unable to provide a CheckedState for the\r
+     * input.\r
+     * \r
+     * @param updater the updater that needs to be invoked through\r
+     *        {@link PrimitiveQueryUpdater#scheduleReplace(NodeContext, org.simantics.browsing.ui.NodeContext.PrimitiveQueryKey, Object)}\r
+     *        to invalidate the result CheckState of this method if when the\r
+     *        state changes in any way.\r
+     * @param context the input for which to create a {@link CheckedState}\r
+     * @param key the key representing the primitive query that resulted in\r
+     *        calling this {@link CheckedStateFactory}\r
+     * @return a CheckedState that describes checkedness aspects of\r
+     *         the specified input context or <code>null</code> if a state\r
+     *         cannot be provided for any reason\r
+     */\r
+    CheckedState create(PrimitiveQueryUpdater updater, NodeContext context, CheckedStateKey key);\r
+\r
+}\r