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%2FLabeler.java;fp=bundles%2Forg.simantics.browsing.ui%2Fsrc%2Forg%2Fsimantics%2Fbrowsing%2Fui%2Fcontent%2FLabeler.java;h=4bc197b0671252c6baf60f8fc6af8d3bd5639714;hp=0000000000000000000000000000000000000000;hb=969bd23cab98a79ca9101af33334000879fb60c5;hpb=866dba5cd5a3929bbeae85991796acb212338a08 diff --git a/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/Labeler.java b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/Labeler.java new file mode 100644 index 000000000..4bc197b06 --- /dev/null +++ b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/Labeler.java @@ -0,0 +1,255 @@ +/******************************************************************************* + * 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 java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.function.Consumer; + +import org.simantics.browsing.ui.GraphExplorer.ModificationContext; +import org.simantics.browsing.ui.NodeContext; +import org.simantics.browsing.ui.PrimitiveQueryUpdater; +import org.simantics.utils.datastructures.ArrayMap; + +/** + * A Labeler is used for describing the viewer labeling aspects of a single UI + * (e.g. tree) node. Labelers are created on a per UI node basis. Labelers are + * created by {@link LabelerFactory}s. + * + *
+ * A Labeler is responsible for providing a modifier for itself ( + * {@link #getModifier(String)}). + *
+ * + *+ * A labeler is also responsible for informing of any changes happening in + * labels to using the {@link PrimitiveQueryUpdater} received by the + * {@link LabelerFactory} that created the Labeler. To signal that the labeler + * has been updated, invoke + * {@link PrimitiveQueryUpdater#scheduleReplace(NodeContext, org.simantics.browsing.ui.NodeContext.PrimitiveQueryKey, Object)} + * and eventually the query system will request the labeler for the new + * results. + *
+ * + * @author Antti Villberg + * + * @see ArrayMap A space-optimized immutable Map implementation for multicolumn values + */ +public interface Labeler { + + public interface LabelerListener { + boolean columnModified(NodeContext context, String columnKey, String label); + boolean columnsModified(NodeContext context, Mapnull
since the existence of this Modifier
+ * should be enough proof that a modifiable value actually does exist
+ * (see {@link Labeler#getModifier(String)}).
+ *
+ * @return the original property value to be modified
+ */
+ public String getValue();
+
+ /**
+ * @param label the label to test for validity
+ * @return null
if the specified label is valid for this
+ * modifier or an error message if the label is invalid
+ */
+ public String isValid(String label);
+
+ /**
+ * @param label the new value to set for the property of this Labeler
+ * modified by this Modifier
+ */
+ public void modify(String label);
+ }
+
+ public static class DeniedModifier implements Modifier {
+
+ final private String message;
+
+ public DeniedModifier(String message) {
+ this.message = message;
+ }
+
+ public String getMessage() {
+ return message;
+ }
+
+ @Override
+ public String getValue() {
+ throw new IllegalStateException();
+ }
+
+ @Override
+ public String isValid(String label) {
+ throw new IllegalStateException();
+ }
+
+ @Override
+ public void modify(String label) {
+ throw new IllegalStateException();
+ }
+
+ }
+
+ /**
+ * An additional interface that a modifier may implement if it wishes to
+ * filter the user's interactive input in some way before it is applied
+ * to the UI control.
+ *
+ * @author Tuukka Lehtonen
+ */
+ public interface FilteringModifier {
+ /**
+ * The filter method receives most recent input received for the edited
+ * field. The method shall return a filtered version of the received
+ * input
that is then applied into the text field as if it
+ * was the user's input.
+ *
+ * @param input
+ * the text that is about to be inserted before filtering
+ * @return filtered input
+ */
+ public String filter(String input);
+ }
+
+ /**
+ * A special modifier for handling editing of enumerations which have a set
+ * of predefined values that cannot change. The editing can therefore be
+ * performed for example using a read-only combo box.
+ *
+ *
+ * {@link #getValue()} must be implemented to return the currently selected
+ * value among the list of possible values returned by {@link #getValues()}.
+ */
+ public interface EnumerationModifier extends Modifier {
+ /**
+ * @return all possible and valid values for the enumeration to be
+ * modified
+ */
+ public List
+ * See
+ * TODO: what is the difference to {@link #getLabels()}, is this really
+ * necessary or just an unnecessary optimization?
+ *
+ *
+ * See null
to ignore reporting
+ */
+ String query(Object parentControl, Object controlItem, int columnIndex, NodeContext context,
+ Consumerorg.simantics.browsing.ui.common.ColumnKeys
for some
+ * re-usable column keys.
+ *
+ * @return a map of all the produced labels where the keys are the column
+ * names and the values are the corresponding column values
+ */
+ Maporg.simantics.browsing.ui.common.ColumnKeys
for some
+ * re-usable column keys.
+ *
+ * @return a map of all the produced labels where the keys are the column
+ * names and the values are the corresponding column values. Use
+ * {@link Labeler#NO_LABELS} or {@link Collections#emptyMap()} when
+ * no labels are available, do not return null
.
+ */
+ Mapnull
if
+ * there is no modifier for that label
+ */
+ Modifier getModifier(ModificationContext context, String key);
+
+ /**
+ * Returns the category of this label. The category is a number used to
+ * allocate elements to bins; the bins are arranged in ascending numeric
+ * order. The elements within a bin are arranged via a second level sort
+ * criterion.
+ *
+ * @return the category
+ *
+ * @return a numeric value to categorize this label.
+ */
+ int getCategory();
+
+ /**
+ * TODO: specify
+ *
+ * @param listener
+ */
+ void setListener(LabelerListener listener);
+
+}