|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.config.ConfigKey<T>
uk.ac.starlink.ttools.plot2.config.OptionConfigKey<Shader>
uk.ac.starlink.ttools.plot2.config.ShaderConfigKey
public class ShaderConfigKey
ConfigKey for selecting shader objects.
Constructor Summary | |
---|---|
ShaderConfigKey(ConfigMeta meta,
Shader[] shaders,
Shader dflt)
Constructor. |
Method Summary | |
---|---|
ShaderConfigKey |
appendShaderDescription()
Appends a list of the available shaders to the end of the existing XML documentation for this key. |
Specifier<Shader> |
createSpecifier()
Constructs a graphical control with which the user can specify a suitable value for association with this key. |
String |
getXmlDescription(Shader shader)
Returns a description in XML of the given option value. |
String |
valueToString(Shader shader)
Invokes the toString method of the supplied option. |
Methods inherited from class uk.ac.starlink.ttools.plot2.config.OptionConfigKey |
---|
addOptionsXml, getOptions, getOptionsXml, setOptionUsage, stringToValue |
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 |
---|
public ShaderConfigKey(ConfigMeta meta, Shader[] shaders, Shader dflt)
meta
- metadatashaders
- list of optionsdflt
- default valueMethod Detail |
---|
public String valueToString(Shader shader)
OptionConfigKey
toString
method of the supplied option.
May be overridden.
valueToString
in class OptionConfigKey<Shader>
shader
- possible value associated with this key
public String getXmlDescription(Shader shader)
OptionConfigKey
OptionConfigKey.valueToString(T)
,
is used by the OptionConfigKey.getOptionsXml()
method to assemble
a described list of the options.
getXmlDescription
in class OptionConfigKey<Shader>
shader
- possible value of this key
public Specifier<Shader> createSpecifier()
ConfigKey
createSpecifier
in class OptionConfigKey<Shader>
public ShaderConfigKey appendShaderDescription()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |