org.trianacode.gui.hci.color

Interface ColorModel

All Known Subinterfaces:

BackgroundColorModel, CableColorModel, NodeColorModel, RegisterableColorModel

All Known Implementing Classes:

DaxColorModel, IWIRColorModel, ScriptColorModel, ShiwaColorModel, TrianaColorModel

public interface ColorModel

An interface used to link colors in the ColorTable with graphical elements.

When a ColorModel is first created it should populate the ColorTable with default colors for each of the color names it uses (note this should be done using the initDefaultColor method in the ColorTable, not setColor).

When the getColor method is called the ColorModel should retrieve the color it associates with the specified graphical element from the ColorTable via its color name.

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Color	getColor(java.lang.String element)
java.awt.Color	getColor(java.lang.String element, Tool tool)
java.lang.String[]	getColorNames()
java.lang.String[]	getElementNames()
java.lang.String	getModelName()

Method Detail

getModelName

java.lang.String getModelName()

Returns:

the name of this Color model

getColorNames

java.lang.String[] getColorNames()

Returns:

the color names that this model uses. These are linked to actual colors by querying the color table.

getElementNames

java.lang.String[] getElementNames()

Returns:

the element names this color model links with color names

getColor

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

Returns:

the color for the specified graphical element when representing the specified tool. If the element is unrecognized this method will return a default color.

getColor

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

Returns:

the color for the specified graphical element not linked to a specific tool. If the element is unrecognized this method will return a default color.