Class ShaderConfigKey
java.lang.Object
uk.ac.starlink.ttools.plot2.config.ConfigKey<T>
uk.ac.starlink.ttools.plot2.config.ChoiceConfigKey<Shader>
uk.ac.starlink.ttools.plot2.config.ShaderConfigKey
ConfigKey for selecting shader objects.
- Since:
- 9 Sep 2014
- Author:
- Mark Taylor
-
Constructor Summary
ConstructorsConstructorDescriptionShaderConfigKey
(ConfigMeta meta, Shader[] shaders, Shader dflt) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionAppends a list of the available shaders, as well as rules for naming custom ones, to the end of the existing XML documentation for this key.static ConfigMeta
createAxisMeta
(String shortName, String longName, String axName) Creates a key description suitable for a colour map applied to a named axis.Constructs a graphical control with which the user can specify a suitable value for association with this key.decodeString
(String sval) Takes a string, and attempts to turn it into an object which may be a value for this key.stringifyValue
(Shader value) 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
-
Constructor Details
-
ShaderConfigKey
Constructor.- Parameters:
meta
- metadatashaders
- list of optionsdflt
- default value
-
-
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<Shader>
- 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<Shader>
- Parameters:
value
- 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<Shader>
- Returns:
- new specifier
-
appendShaderDescription
Appends a list of the available shaders, as well as rules for naming custom ones, to the end of the existing XML documentation for this key.- Returns:
- this object, as a convenience
-
createAxisMeta
Creates a key description suitable for a colour map applied to a named axis.- Parameters:
shortName
- metadata short namelongName
- metadata long nameaxName
- user-readable name of axis to which this applies- Returns:
- new metadata object
-