uk.ac.starlink.ttools.plot2.config
Class ColorConfigKey

java.lang.Object
  extended by uk.ac.starlink.ttools.plot2.config.ConfigKey<T>
      extended by uk.ac.starlink.ttools.plot2.config.ChoiceConfigKey<Color>
          extended by uk.ac.starlink.ttools.plot2.config.ColorConfigKey

public class ColorConfigKey
extends ChoiceConfigKey<Color>

ConfigKey for selecting colours. A null colour is optionally available, controlled by a toggle switch.

Since:
9 Sep 2014
Author:
Mark Taylor

Constructor Summary
ColorConfigKey(ConfigMeta meta, Color dflt, boolean allowHide)
          Constructor.
 
Method Summary
static ConfigMeta createColorMeta(String shortName, String longName, String theItem)
          Returns a metadata object suitable for use with a ColorConfigKey.
 Specifier<Color> createSpecifier()
          Constructs a graphical control with which the user can specify a suitable value for association with this key.
 Color decodeString(String sval)
          Takes a string, and attempts to turn it into an object which may be a value for this key.
 String stringifyValue(Color color)
          Takes an object which may be a value of this key, and attempts to turn it into a string for reporting purposes.
 
Methods inherited from class uk.ac.starlink.ttools.plot2.config.ChoiceConfigKey
addOption, getOptionMap, stringToValue, valueToString
 
Methods inherited from class uk.ac.starlink.ttools.plot2.config.ConfigKey
cast, getDefaultValue, getMeta, getValueClass, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ColorConfigKey

public ColorConfigKey(ConfigMeta meta,
                      Color dflt,
                      boolean allowHide)
Constructor.

Parameters:
meta - metadata
dflt - default value
allowHide - true if hiding the colour, which results in a null value, is a legal option
Method Detail

decodeString

public Color decodeString(String sval)
Description copied from class: ChoiceConfigKey
Takes a string, and attempts to turn it into an object which may be a value for this key. If the string is not of a recognised form, null is returned.

This method should be the opposite of ChoiceConfigKey.stringifyValue(T), but does not need to be consistent with stringToValue or valueToString.

Specified by:
decodeString in class ChoiceConfigKey<Color>
Parameters:
sval - string representation
Returns:
typed object represented by sval, or null

stringifyValue

public String stringifyValue(Color color)
Description copied from class: ChoiceConfigKey
Takes an object which may be a value of this key, and attempts to turn it into a string for reporting purposes.

This method should if possible be the opposite of ChoiceConfigKey.decodeString(java.lang.String), but does not need to be consistent with stringToValue or valueToString. If no round-trippable value is available, null should be returned.

Specified by:
stringifyValue in class ChoiceConfigKey<Color>
Parameters:
color - typed object
Returns:
string representing object, or null

createSpecifier

public Specifier<Color> createSpecifier()
Description copied from class: ConfigKey
Constructs a graphical control with which the user can specify a suitable value for association with this key.

Specified by:
createSpecifier in class ConfigKey<Color>
Returns:
new specifier

createColorMeta

public static ConfigMeta createColorMeta(String shortName,
                                         String longName,
                                         String theItem)
Returns a metadata object suitable for use with a ColorConfigKey.

Parameters:
shortName - key name for use in command-line interface
longName - key name for use in GUI
theItem - description of the item to use in free-form text, for instance "the plot grid"
Returns:
colour config metadata


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.