org.trianacode.gui.hci.color

Class ColorManager

java.lang.Object

org.trianacode.gui.hci.color.ColorManager

public class ColorManager
extends java.lang.Object

The ColorManager maintains a register of ColorModels for different tool class types, and a default ColorModel which handles tool class types and color elements not handled by a specific ColorModel. Components can query the ColorManager to discover the color value for particular graphical elements based on class of the tool they are visualizing.

Constructor Summary

Constructors

Constructor and Description
ColorManager()

Method Summary

Methods

Modifier and Type	Method and Description
static java.awt.Color	getBackgroundColor()
static java.awt.Color	getColor(Cable cable)
static java.awt.Color	getColor(Node node)
static java.awt.Color	getColor(java.lang.String element)
static java.awt.Color	getColor(java.lang.String element, Tool tool)
static ColorModel	getDefaultColorModel()
static ColorModel	getRegisteredColorModel(java.lang.String toolclass)
static ColorModel[]	getRegisteredColorModels()
static java.lang.String[]	getRegisteredToolClasses()
static boolean	isRegisteredColorModel(java.lang.String toolclass)
static void	registerColorModel(java.lang.String toolclass, ColorModel model) Registers a color model to handle the color values for a particular tool class.
static void	setDefaultColorModel(ColorModel model) Sets the default color model used when no color model is registered for a tool class.
static void	unregisterColorModel(java.lang.String toolclass) Unregisters a color model for a tool class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ColorManager

public ColorManager()

Method Detail

getDefaultColorModel

public static ColorModel getDefaultColorModel()

Returns:

the default color model used when no color model is registered for a tool class.

setDefaultColorModel

public static void setDefaultColorModel(ColorModel model)

Sets the default color model used when no color model is registered for a tool class.

registerColorModel

public static void registerColorModel(java.lang.String toolclass,
                      ColorModel model)

Registers a color model to handle the color values for a particular tool class. Note that if two models are registered for a tool then the later registered takes precedence.

unregisterColorModel

public static void unregisterColorModel(java.lang.String toolclass)

Unregisters a color model for a tool class.

getRegisteredToolClasses

public static java.lang.String[] getRegisteredToolClasses()

Returns:

an array of tool classes for which color models are registered

getRegisteredColorModel

public static ColorModel getRegisteredColorModel(java.lang.String toolclass)

Returns:

the color model regiseted for the specified tool class (or null if no model is registered, i.e. the default color model is used)

isRegisteredColorModel

public static boolean isRegisteredColorModel(java.lang.String toolclass)

Returns:

true if a color model is registered for the specified tool class

getRegisteredColorModels

public static ColorModel[] getRegisteredColorModels()

Returns:

an array fo the registered color models (including the default color model)

getColor

public static java.awt.Color getColor(java.lang.String element,
                      Tool tool)

Returns:

the color for the particular graphical element of the specified tool. Note that if two models are registered for a tool then the later registered takes precedence.

getColor

public static java.awt.Color getColor(java.lang.String element)

Returns:

the color for the particular graphical element not associated withd a specific tool

getColor

public static java.awt.Color getColor(Node node)

Returns:

the color for the particular node

getColor

public static java.awt.Color getColor(Cable cable)

Returns:

the color for the particular cable

getBackgroundColor

public static java.awt.Color getBackgroundColor()