Package adams.gui.visualization.core

Class GradientColorProvider

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.core.AbstractColorProvider

adams.gui.visualization.core.GradientColorProvider

All Implemented Interfaces:

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

public class GradientColorProvider
extends AbstractColorProvider

Uses a color gradient generator to generate the colors.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-generator <adams.gui.visualization.core.ColorGradientGenerator> (property: generator)
    The generator to use for generating the gradient.
    default: adams.gui.visualization.core.BiColorGenerator
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ColorGradientGenerator	m_Generator	the gradient generator to use.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	generatorTipText()	Returns the tip text for this property.
ColorGradientGenerator	getGenerator()	Returns the generator in use.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
void	resetColors()	Resets the colors.
void	setGenerator(ColorGradientGenerator value)	Sets the generator to use.

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

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

Methods inherited from class adams.core.option.AbstractOptionHandler

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

protected ColorGradientGenerator m_Generator

the gradient generator to use.

Constructor Detail

GradientColorProvider

public GradientColorProvider()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractColorProvider

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setGenerator

public void setGenerator(ColorGradientGenerator value)

Sets the generator to use.

Parameters:

value - the generator to use

getGenerator

public ColorGradientGenerator getGenerator()

Returns the generator in use.

Returns:

the generator in use

generatorTipText

public String generatorTipText()

Returns the tip text for this property.

Returns:

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

resetColors

public void resetColors()

Resets the colors.

Specified by:

resetColors in interface ColorProvider

Overrides:

resetColors in class AbstractColorProvider