Package adams.gui.visualization.object.objectannotations.colors

Class TypeColorMapping

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.object.objectannotations.colors.AbstractAnnotationColors

adams.gui.visualization.object.objectannotations.colors.TypeColorMapping

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, AnnotationColors, Serializable

public class TypeColorMapping
extends AbstractAnnotationColors

Uses the colors defined for each type.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseColor[]	m_Colors	the colors.
protected Color	m_FallbackColor	the fallback color for labels that have no color defined.
protected HashMap<String,Color>	m_Mapping	the type/color mapping.
protected String	m_MetaDataKey	the key in the meta-data that contains the type.
protected Color	m_NoTypeColor	the color to use if no type present.
protected BaseString[]	m_Types	the types.

Fields inherited from class adams.gui.visualization.object.objectannotations.colors.AbstractAnnotationColors

m_Enabled

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
TypeColorMapping()

Method Summary

Modifier and Type	Method	Description
String	colorsTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Color	doGetColor(LocatedObject object)	Returns the color for the object.
protected void	doInitColors(LocatedObjects objects, MessageCollection errors)	Initializes the colors with the annotations.
String	fallbackColorTipText()	Returns the tip text for this property.
protected String	generateQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
BaseColor[]	getColors()	Returns the colors associated with the types/labels.
Color	getFallbackColor()	Returns the color to use when a label has no color associated.
String	getMetaDataKey()	Returns the key in the meta-data of the object that contains the type.
Color	getNoTypeColor()	Returns the color to use when no type information available.
BaseString[]	getTypes()	Returns the types/labels.
String	globalInfo()	Returns a string describing the object.
String	metaDataKeyTipText()	Returns the tip text for this property.
String	noTypeColorTipText()	Returns the tip text for this property.
void	setColors(BaseColor[] value)	Sets the colors associated with the types/labels.
void	setFallbackColor(Color value)	Sets the color to use when a label has no color associated.
void	setMetaDataKey(String value)	Sets the key in the meta-data of the object that contains the type.
void	setNoTypeColor(Color value)	Sets the color to use when no type information available.
void	setTypes(BaseString[] value)	Sets the types/labels.
String	typesTipText()	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.object.objectannotations.colors.AbstractAnnotationColors

check, enabledTipText, getColor, getEnabled, getQuickInfo, initColors, setEnabled

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_MetaDataKey

protected String m_MetaDataKey

the key in the meta-data that contains the type.

m_Types

protected BaseString[] m_Types

the types.

m_Colors

protected BaseColor[] m_Colors

the colors.

m_FallbackColor

protected Color m_FallbackColor

the fallback color for labels that have no color defined.

m_NoTypeColor

protected Color m_NoTypeColor

the color to use if no type present.

m_Mapping

protected transient HashMap<String,Color> m_Mapping

the type/color mapping.

Constructor Detail

TypeColorMapping

public TypeColorMapping()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractAnnotationColors

setMetaDataKey

public void setMetaDataKey(String value)

Sets the key in the meta-data of the object that contains the type.

Parameters:

value - the key

getMetaDataKey

public String getMetaDataKey()

Returns the key in the meta-data of the object that contains the type.

Returns:

the key

metaDataKeyTipText

public String metaDataKeyTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setTypes

public void setTypes(BaseString[] value)

Sets the types/labels.

Parameters:

value - the types

getTypes

public BaseString[] getTypes()

Returns the types/labels.

Returns:

the types

typesTipText

public String typesTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setColors

public void setColors(BaseColor[] value)

Sets the colors associated with the types/labels.

Parameters:

value - the colors

getColors

public BaseColor[] getColors()

Returns the colors associated with the types/labels.

Returns:

the colors

colorsTipText

public String colorsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setFallbackColor

public void setFallbackColor(Color value)

Sets the color to use when a label has no color associated.

Parameters:

value - the color

getFallbackColor

public Color getFallbackColor()

Returns the color to use when a label has no color associated.

Returns:

the color

fallbackColorTipText

public String fallbackColorTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setNoTypeColor

public void setNoTypeColor(Color value)

Sets the color to use when no type information available.

Parameters:

value - the color

getNoTypeColor

public Color getNoTypeColor()

Returns the color to use when no type information available.

Returns:

the color

noTypeColorTipText

public String noTypeColorTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

generateQuickInfo

protected String generateQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Overrides:

generateQuickInfo in class AbstractAnnotationColors

Returns:

null if no info available, otherwise short string

doInitColors

protected void doInitColors(LocatedObjects objects,
                            MessageCollection errors)

Initializes the colors with the annotations.

Specified by:

doInitColors in class AbstractAnnotationColors

Parameters:

objects - the annotations to use for initialization

errors - for collecting errors

doGetColor

protected Color doGetColor(LocatedObject object)

Returns the color for the object.

Specified by:

doGetColor in class AbstractAnnotationColors

Parameters:

object - the annotation to get the color for