bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/LabelDecoratorFactory.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.browsing.ui.content;\r
  13 \r
  14 import org.simantics.browsing.ui.NodeContext;\r
  15 import org.simantics.browsing.ui.PrimitiveQueryUpdater;\r
  16 import org.simantics.browsing.ui.BuiltinKeys.LabelDecoratorKey;\r
  17 \r
  18 \r
  19 /**\r
  20  * An interface for constructing decorators for controlling the aesthetic\r
  21  * properties of an UI item, including the label text, font, background color\r
  22  * and foreground color.\r
  23  * \r
  24  * @author Tuukka Lehtonen\r
  25  */\r
  26 public interface LabelDecoratorFactory {\r
  27 \r
  28     /**\r
  29      * @param manager the manager for performing more queries to decide how to\r
  30      *        decorate the label of the specified input\r
  31      * @param context the input node context to evaluate for decoration\r
  32      * @return <code>null</code> if no decoration is desired for the specified\r
  33      *         input\r
  34      */\r
  35     LabelDecorator create(PrimitiveQueryUpdater manager, NodeContext context, LabelDecoratorKey key);\r
  36 \r
  37 }\r