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

Class FixedColor

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.FixedColor

All Implemented Interfaces:

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

public class FixedColor
extends AbstractAnnotationColors

Uses a single, fixed color.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	m_Color	the fixed color to use.

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
FixedColor()

Method Summary

Modifier and Type	Method	Description
String	colorTipText()	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.
protected String	generateQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
Color	getColor()	Returns the color to use.
String	globalInfo()	Returns a string describing the object.
void	setColor(Color value)	Sets the color to use.

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_Color

protected Color m_Color

the fixed color to use.

Constructor Detail

FixedColor

public FixedColor()

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

setColor

public void setColor(Color value)

Sets the color to use.

Parameters:

value - the color

getColor

public Color getColor()

Returns the color to use.

Returns:

the color

colorTipText

public String colorTipText()

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