Class ColorConfigKey
Some of the colours come from Paul Tol's colour scheme notes; see Paul Tol's Notes page and SRON/EPS/TN/09-002. The version of the Tech Note used here is dated 29 December 2012.
- Since:
- 9 Sep 2014
- Author:
- Mark Taylor
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionColorConfigKey
(ConfigMeta meta, String dfltName, boolean allowHide) Constructs a config key using the default colour option list.ColorConfigKey
(ConfigMeta meta, String dfltName, boolean allowHide, Map<String, Color> colorOpts) Constructs a config key using a supplied colour option list. -
Method Summary
Modifier and TypeMethodDescriptionReturns the default plotting colours used by TOPCAT, at least in early versions.static ConfigMeta
createColorMeta
(String shortName, String longName, String theItem) Returns a metadata object suitable for use with a ColorConfigKey.Constructs a graphical control with which the user can specify a suitable value for association with this key.Returns a group of colours using the second (5-colour) row of figure 13 in SRON/EPS/TN/09-002.Returns a group of colours using the fourth (7-colour) row of figure 13 in SRON/EPS/TN/09-002.Returns a group of colours based on the "Alternative Colour Scheme" on Paul Tol's page, but not in the TechNode.static Color
decodeColorName
(String sval) Turns a string into a colour by looking at known colour names or using RRGGBB syntax.decodeString
(String sval) Takes a string, and attempts to turn it into an object which may be a value for this key.static Color[]
Returns an array of the colour options suitable for plotting normal markers.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
-
Field Details
-
SRON5_COLORS
-
SRON7_COLORS
-
SRONBRIGHT_COLORS
-
CLASSIC_COLORS
-
COLORNAME_RED
Standard colour name for red.- See Also:
-
COLORNAME_BLACK
Standard colour name for black.- See Also:
-
COLORNAME_GREY
Standard colour name for grey.- See Also:
-
COLORNAME_LIGHTGREY
Standard colour name for light grey.- See Also:
-
-
Constructor Details
-
ColorConfigKey
Constructs a config key using the default colour option list.The supplied
dfltName
names one of the colours in the default map. The static finalCOLORNAME_*
members are guaranteed to be represented. If null is supplied, a sensible default (the first in the list) is used.- Parameters:
meta
- metadatadfltName
- name of default colour, or nullallowHide
- true if hiding the colour, which results in a null value, is a legal option
-
ColorConfigKey
public ColorConfigKey(ConfigMeta meta, String dfltName, boolean allowHide, Map<String, Color> colorOpts) Constructs a config key using a supplied colour option list.- Parameters:
meta
- metadatadfltName
- name of default colour; should be one of the keys incolorOpts
or nullallowHide
- true if hiding the colour, which results in a null value, is a legal optioncolorOpts
- name-> colour map
-
-
Method Details
-
decodeString
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 withstringToValue
orvalueToString
.- Specified by:
decodeString
in classChoiceConfigKey<Color>
- Parameters:
sval
- string representation- Returns:
- typed object represented by sval, or null
-
stringifyValue
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 withstringToValue
orvalueToString
. If no round-trippable value is available, null should be returned.- Specified by:
stringifyValue
in classChoiceConfigKey<Color>
- Parameters:
color
- typed object- Returns:
- string representing object, or null
-
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 classConfigKey<Color>
- Returns:
- new specifier
-
createColorMeta
Returns a metadata object suitable for use with a ColorConfigKey. The standard colour set is used.- Parameters:
shortName
- key name for use in command-line interfacelongName
- key name for use in GUItheItem
- description of the item to use in free-form text, for instance "the plot grid"- Returns:
- colour config metadata
-
decodeColorName
Turns a string into a colour by looking at known colour names or using RRGGBB syntax.- Parameters:
sval
- string colour identifier- Returns:
- colour named by sval, or null if none is identified
-
getPlottingColors
Returns an array of the colour options suitable for plotting normal markers.- Returns:
- colour option array
-
createClassicColors
Returns the default plotting colours used by TOPCAT, at least in early versions.- Returns:
- name->colour map
-
createSron5Colors
Returns a group of colours using the second (5-colour) row of figure 13 in SRON/EPS/TN/09-002.- Returns:
- name->colour map
-
createSron7Colors
Returns a group of colours using the fourth (7-colour) row of figure 13 in SRON/EPS/TN/09-002.- Returns:
- name->colour map
-
createSronBrightColors
Returns a group of colours based on the "Alternative Colour Scheme" on Paul Tol's page, but not in the TechNode. Bright yellow is omitted on the grounds that it's too light.- Returns:
- name->colour map
-