Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.g2d / src / org / simantics / g2d / element / SceneGraphNodeKey.java

diff --git a/bundles/org.simantics.g2d/src/org/simantics/g2d/element/SceneGraphNodeKey.java b/bundles/org.simantics.g2d/src/org/simantics/g2d/element/SceneGraphNodeKey.java
new file mode 100644 (file)
index 0000000..be438ba
--- /dev/null
+++ b/bundles/org.simantics.g2d/src/org/simantics/g2d/element/SceneGraphNodeKey.java
@@ -0,0 +1,37 @@
+/*******************************************************************************\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.g2d.element;\r
+\r
+import org.simantics.scenegraph.Node;\r
+import org.simantics.utils.datastructures.hints.IHintContext.KeyOf;\r
+\r
+/**\r
+ * A hint key class that should be used for defining hints that attach\r
+ * org.simantics.scenegraph {@link Node}s to {@link IElement}s.\r
+ * \r
+ * The reason for having this class is to be able to identify all hints\r
+ * containing scene graph nodes, allowing for proper cleanup.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+final public class SceneGraphNodeKey extends KeyOf {\r
+\r
+    public SceneGraphNodeKey(Class<?> clazz, String keyName) {\r
+        super(clazz, keyName);\r
+    }\r
+    \r
+    @Override\r
+    public boolean isValueAccepted(Object value) {\r
+       return true;\r
+    }\r
+\r
+}\r