Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui.common / src / org / simantics / browsing / ui / common / internal / IGraphExplorerContext.java

diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/internal/IGraphExplorerContext.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/internal/IGraphExplorerContext.java
new file mode 100644 (file)
index 0000000..13888d0
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/internal/IGraphExplorerContext.java
@@ -0,0 +1,64 @@
+/*******************************************************************************\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.internal;\r
+\r
+import java.util.Deque;\r
+import java.util.List;\r
+\r
+import org.simantics.browsing.ui.DataSource;\r
+import org.simantics.browsing.ui.GraphExplorer;\r
+import org.simantics.browsing.ui.NodeQueryProcessor;\r
+import org.simantics.browsing.ui.PrimitiveQueryProcessor;\r
+import org.simantics.utils.datastructures.disposable.IDisposable;\r
+\r
+/**\r
+ * An internal interface for supporting the implementation of\r
+ * {@link GraphExplorer}. Contains methods for the interaction of GraphExplorer\r
+ * and {@link GENodeQueryManager}, and {@link UpdateRunner}.\r
+ * \r
+ * <p>\r
+ * The main purpose of this context class is to support switching of explorer\r
+ * inputs in a proper way which disposes all the {@link GENodeQueryManager}'s\r
+ * and any resource queries possibly hidden behind them.\r
+ * </p>\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public interface IGraphExplorerContext extends IDisposable {\r
+\r
+    int queryIndent();\r
+    int queryIndent(int offset);\r
+\r
+    IGECache getCache();\r
+\r
+    <T> NodeQueryProcessor<T> getProcessor(Object o);\r
+    <T> PrimitiveQueryProcessor<T> getPrimitiveProcessor(Object o);\r
+    <T> DataSource<T> getDataSource(Class<T> clazz);\r
+\r
+    void update(UIElementReference ref);\r
+\r
+    Object getPropagateLock();\r
+    Object getPropagateListLock();\r
+\r
+    void setPropagating(boolean b);\r
+    boolean isPropagating();\r
+\r
+    void setScheduleList(List<Runnable> list);\r
+    List<Runnable> getScheduleList();\r
+\r
+    Deque<Integer> getActivity();\r
+    void setActivityInt(int i);\r
+    int getActivityInt();\r
+\r
+    void scheduleQueryUpdate(Runnable r);\r
+\r
+}\r