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

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