X-Git-Url: https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=blobdiff_plain;f=bundles%2Forg.simantics.browsing.ui%2Fsrc%2Forg%2Fsimantics%2Fbrowsing%2Fui%2Fcontent%2FLabelerFactory.java;fp=bundles%2Forg.simantics.browsing.ui%2Fsrc%2Forg%2Fsimantics%2Fbrowsing%2Fui%2Fcontent%2FLabelerFactory.java;h=fc795e99fa687e2163fbbaa6b2b4d68bdd86589b;hp=0000000000000000000000000000000000000000;hb=969bd23cab98a79ca9101af33334000879fb60c5;hpb=866dba5cd5a3929bbeae85991796acb212338a08

diff --git a/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/LabelerFactory.java b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/LabelerFactory.java
new file mode 100644
index 000000000..fc795e99f
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/LabelerFactory.java
@@ -0,0 +1,41 @@
+/*******************************************************************************
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management
+ * in Industry THTH ry.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     VTT Technical Research Centre of Finland - initial API and implementation
+ *******************************************************************************/
+package org.simantics.browsing.ui.content;
+
+import org.simantics.browsing.ui.NodeContext;
+import org.simantics.browsing.ui.PrimitiveQueryUpdater;
+import org.simantics.browsing.ui.BuiltinKeys.LabelerKey;
+
+/**
+ * @author Antti Villberg
+ */
+public interface LabelerFactory {
+
+    /**
+     * Returns a labeler for the specified input node context or
+     * <code>null</code> if this factory is unable to provide a labeler for the
+     * input. See {@link Labeler} for more on its purpose.
+     * 
+     * @param updater the updater that needs to be invoked through
+     *        {@link PrimitiveQueryUpdater#scheduleReplace(NodeContext, org.simantics.browsing.ui.NodeContext.PrimitiveQueryKey, Object)}
+     *        to invalidate the result Labeler of this method if when the
+     *        labeler changes in any way.
+     * @param context the input for which to create a {@link Labeler}
+     * @param key the key representing the primitive query that resulted in
+     *        calling this {@link LabelerFactory}
+     * @return a Labeler that describes labeling and label editing aspects of
+     *         the specified input context or <code>null</code> if a labeler
+     *         cannot be provided for any reason
+     */
+    Labeler create(PrimitiveQueryUpdater updater, NodeContext context, LabelerKey key);
+
+}