Package adams.gui.visualization.core

Class AbstractCustomColorProvider

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.core.AbstractColorProvider

adams.gui.visualization.core.AbstractCustomColorProvider

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<ColorProvider>, SizeOfHandler, ColorProvider, Serializable

Direct Known Subclasses:

ColorBlind12Provider, ColorBlind15Provider, ColorBlind24Provider, ColorBlind8Provider, CustomColorProvider

public abstract class AbstractCustomColorProvider
extends AbstractColorProvider

Ancestor for custom color providers.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.gui.visualization.core.AbstractColorProvider

m_AllowDarkening, m_CheckTooDark, m_Colors, m_DefaultColors, m_ExcludedColors, m_FirstIteration, m_Index, m_RecycledColors, MIN_VALUE

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

Method Summary

Modifier and Type	Method	Description
String	allowDarkeningTipText()	Returns the tip text for this property.
String	colorsTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
boolean	getAllowDarkening()	Returns whether to allow the darkening of colors.
Color[]	getColors()	Returns the colors in use.
protected abstract Color[]	getDefaultColors()	Returns the default colors to use.
protected abstract boolean	isDarkeningEnabled()	Returns whether the allow-darkening option is enabled.
void	setAllowDarkening(boolean value)	Sets whether to allow the darkening of colors.
void	setColors(Color[] value)	Sets the colors to use.

Methods inherited from class adams.gui.visualization.core.AbstractColorProvider

exclude, finishInit, forCommandLine, forName, initialize, next, recycle, resetColors, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

Constructor Detail

AbstractCustomColorProvider

public AbstractCustomColorProvider()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

getDefaultColors

protected abstract Color[] getDefaultColors()

Returns the default colors to use.

Returns:

the colors

setColors

public void setColors(Color[] value)

Sets the colors to use.

Parameters:

value - the colors to use

getColors

public Color[] getColors()

Returns the colors in use.

Returns:

the colors in use

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.

isDarkeningEnabled

protected abstract boolean isDarkeningEnabled()

Returns whether the allow-darkening option is enabled.

Returns:

true if enabled

setAllowDarkening

public void setAllowDarkening(boolean value)

Sets whether to allow the darkening of colors.

Parameters:

value - if true colors are re-used in darker versions

getAllowDarkening

public boolean getAllowDarkening()

Returns whether to allow the darkening of colors.

Returns:

true if colors are re-used in darker versions

allowDarkeningTipText

public String allowDarkeningTipText()

Returns the tip text for this property.

Returns:

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