Package adams.gui.visualization.core
Class MultiColorGenerator
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.gui.visualization.core.AbstractColorGradientGenerator
-
- adams.gui.visualization.core.MultiColorGenerator
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,SizeOfHandler
,ColorGradientGenerator
,Serializable
,Comparable
public class MultiColorGenerator extends AbstractColorGradientGenerator
Generates gradient colors between multiple colors.
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-num-colors <int> (property: numColors) The number of colors in the gradient to use. default: 255 minimum: 1
-color <java.awt.Color> [-color ...] (property: colors) The colors to use for the gradient. default: #0000b2, #00b200, #b20000, #ffff00
-alpha <int> (property: alpha) The alpha value to use (0=transparent, 255=opaque); ignored if 255. default: 255 minimum: 0 maximum: 255
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected int
m_Alpha
the alpha value to use (ignored if 255).protected Color[]
m_Colors
the colors to create the gradient with.protected int
m_NumColors
the number of gradient colors.-
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 MultiColorGenerator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
alphaTipText()
Returns the tip text for this property.protected void
check()
Hook method for performing checks on the setup.String
colorsTipText()
Returns the tip text for this property.void
defineOptions()
Adds options to the internal list of options.protected Color[]
doGenerate()
Performs the actual generation.int
getAlpha()
Returns the alpha value to use (0=transparent, 255=opaque); ignored if 255.Color[]
getColors()
Returns the colors of the gradient.int
getNumColors()
Returns the number of gradient colors to use.String
globalInfo()
Returns a string describing the object.String
numColorsTipText()
Returns the tip text for this property.void
setAlpha(int value)
Sets the alpha value to use (0=transparent, 255=opaque); ignored if 255.void
setColors(Color[] value)
Sets the colors of the gradient.void
setNumColors(int value)
Sets the number of gradient colors to use.-
Methods inherited from class adams.gui.visualization.core.AbstractColorGradientGenerator
compareTo, equals, forCommandLine, forName, generate, getGenerators, shallowCopy, shallowCopy
-
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, 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_NumColors
protected int m_NumColors
the number of gradient colors.
-
m_Colors
protected Color[] m_Colors
the colors to create the gradient with.
-
m_Alpha
protected int m_Alpha
the alpha value to use (ignored if 255).
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- 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 interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractOptionHandler
-
setNumColors
public void setNumColors(int value)
Sets the number of gradient colors to use.- Parameters:
value
- the number of colors
-
getNumColors
public int getNumColors()
Returns the number of gradient colors to use.- Returns:
- the number of colors
-
numColorsTipText
public String numColorsTipText()
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(Color[] value)
Sets the colors of the gradient.- Parameters:
value
- the colors
-
getColors
public Color[] getColors()
Returns the colors of the gradient.- 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.
-
setAlpha
public void setAlpha(int value)
Sets the alpha value to use (0=transparent, 255=opaque); ignored if 255.- Parameters:
value
- the alpha value
-
getAlpha
public int getAlpha()
Returns the alpha value to use (0=transparent, 255=opaque); ignored if 255.- Returns:
- the alpha value
-
alphaTipText
public String alphaTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
check
protected void check()
Hook method for performing checks on the setup.- Overrides:
check
in classAbstractColorGradientGenerator
-
doGenerate
protected Color[] doGenerate()
Performs the actual generation.- Specified by:
doGenerate
in classAbstractColorGradientGenerator
- Returns:
- the generated colors
-
-