Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui / src / org / simantics / browsing / ui / content / LabelDecoratorFactory.java

diff --git a/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/LabelDecoratorFactory.java b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/LabelDecoratorFactory.java
new file mode 100644 (file)
index 0000000..3bb5706
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/LabelDecoratorFactory.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.browsing.ui.content;\r
+\r
+import org.simantics.browsing.ui.NodeContext;\r
+import org.simantics.browsing.ui.PrimitiveQueryUpdater;\r
+import org.simantics.browsing.ui.BuiltinKeys.LabelDecoratorKey;\r
+\r
+\r
+/**\r
+ * An interface for constructing decorators for controlling the aesthetic\r
+ * properties of an UI item, including the label text, font, background color\r
+ * and foreground color.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public interface LabelDecoratorFactory {\r
+\r
+    /**\r
+     * @param manager the manager for performing more queries to decide how to\r
+     *        decorate the label of the specified input\r
+     * @param context the input node context to evaluate for decoration\r
+     * @return <code>null</code> if no decoration is desired for the specified\r
+     *         input\r
+     */\r
+    LabelDecorator create(PrimitiveQueryUpdater manager, NodeContext context, LabelDecoratorKey key);\r
+\r
+}\r