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=6ce1963d57c953f0f4e3f66dcead4f61ae0763ce;hp=fc795e99fa687e2163fbbaa6b2b4d68bdd86589b;hb=0ae2b770234dfc3cbb18bd38f324125cf0faca07;hpb=24e2b34260f219f0d1644ca7a138894980e25b14 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 index fc795e99f..6ce1963d5 100644 --- 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 @@ -1,41 +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 - * null 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 null if a labeler - * cannot be provided for any reason - */ - Labeler create(PrimitiveQueryUpdater updater, NodeContext context, LabelerKey key); - -} +/******************************************************************************* + * 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 + * null 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 null if a labeler + * cannot be provided for any reason + */ + Labeler create(PrimitiveQueryUpdater updater, NodeContext context, LabelerKey key); + +}