Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.scenegraph.profile / src / org / simantics / scenegraph / profile / Group.java

diff --git a/bundles/org.simantics.scenegraph.profile/src/org/simantics/scenegraph/profile/Group.java b/bundles/org.simantics.scenegraph.profile/src/org/simantics/scenegraph/profile/Group.java
new file mode 100644 (file)
index 0000000..ff14049
--- /dev/null
+++ b/bundles/org.simantics.scenegraph.profile/src/org/simantics/scenegraph/profile/Group.java
@@ -0,0 +1,42 @@
+/*******************************************************************************\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.scenegraph.profile;\r
+\r
+import org.simantics.db.RequestProcessor;\r
+import org.simantics.db.Resource;\r
+import org.simantics.db.procedure.SetListener;\r
+\r
+\r
+/**\r
+ * Groups are a part of the diagram profile framework. They are used to form and\r
+ * keep track of the group of objects on which {@link Style}s operate.\r
+ * \r
+ * @author Antti Villberg\r
+ */\r
+public interface Group {\r
+\r
+    /**\r
+     * Allows styles to start tracking the set of objects (resources) listed by\r
+     * this Group implementation through the specified {@link SetListener}.\r
+     * \r
+     * @param processor graph database access handle\r
+     * @param runtimeDiagram runtime resource of the active diagram editor\r
+     *        instance\r
+     * @param configuration variable access to the diagram's mapped\r
+     *        configuration\r
+     * @param listener the listener to notify of changes in the tracked set of\r
+     *        objects. Usually one just delegates normal database listener\r
+     *        events to this listener.\r
+     */\r
+    void trackItems(RequestProcessor processor, Resource runtimeDiagram, SetListener<Resource> listener);\r
+\r
+}\r