Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui.common / src / org / simantics / browsing / ui / common / modifiers / AbstractEnumerationModifier.java

diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/modifiers/AbstractEnumerationModifier.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/modifiers/AbstractEnumerationModifier.java
new file mode 100644 (file)
index 0000000..d42d09b
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/modifiers/AbstractEnumerationModifier.java
@@ -0,0 +1,85 @@
+/*******************************************************************************\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.modifiers;\r
+\r
+import java.util.ArrayList;\r
+import java.util.List;\r
+\r
+import org.simantics.browsing.ui.content.Labeler.EnumerationModifier;\r
+\r
+/**\r
+ * A trivial EnumerationModifier base implementation\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public abstract class AbstractEnumerationModifier<T> implements EnumerationModifier {\r
+\r
+    private final Enumeration<T>     enumeration;\r
+    private final EnumeratedValue<T> value;\r
+    private final List<String>       values;\r
+\r
+    public AbstractEnumerationModifier(Enumeration<T> enumeration, EnumeratedValue<T> value) {\r
+        assert enumeration != null;\r
+        assert enumeration.size() > 0;\r
+\r
+        this.enumeration = enumeration;\r
+        this.value = value;\r
+\r
+        this.values = new ArrayList<String>(enumeration.size());\r
+        for (EnumeratedValue<T> v : enumeration.values())\r
+            values.add(v.getName());\r
+    }\r
+\r
+    @Override\r
+    public final List<String> getValues() {\r
+        return values;\r
+    }\r
+\r
+    @Override\r
+    public final String getValue() {\r
+        if (value != null)\r
+            return value.getName();\r
+        return enumeration.values().get(0).getName();\r
+    }\r
+\r
+    @Override\r
+    public final String isValid(String label) {\r
+        if (!values.contains(label))\r
+            return "Value '" + label + "' is not among the enumerated values " + values;\r
+        return null;\r
+    }\r
+\r
+    @Override\r
+    public final void modify(String label) {\r
+        int index = values.indexOf(label);\r
+        if (index == -1)\r
+            throw new IllegalArgumentException("Cannot modify enumeration with value '" + label + "', not among the enumerated values " + values);\r
+        modifyWithValue(value, enumeration.values().get(index));\r
+    }\r
+\r
+    protected void modifyWithValue(EnumeratedValue<T> oldEnumValue, EnumeratedValue<T> enumValue) {\r
+        T oldObject = oldEnumValue != null ? oldEnumValue.getObject() : null;\r
+        T newObject = enumValue != null ? enumValue.getObject() : null;\r
+        modifyWithObject(oldObject, newObject);\r
+    }\r
+\r
+    /**\r
+     * At least implement this if you don't override\r
+     * {@link #modifyWithValue(EnumeratedValue, EnumeratedValue)}.\r
+     * \r
+     * @param oldEnumObject\r
+     * @param enumObject\r
+     */\r
+    protected void modifyWithObject(T oldEnumObject, T enumObject) {\r
+    }\r
+\r
+};\r