|
|||||||||
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<T>
public abstract class OptionConfigKey<T>
Config key for use with items that can be chosen from a list of options.
The list is basically closed, though it may be possible programmatically
to supply an object of the required type.
For open lists of options see ChoiceConfigKey
.
Constructor Summary | |
---|---|
OptionConfigKey(ConfigMeta meta,
Class<T> clazz,
T[] options)
Constructor that uses the first of the supplied options as a default. |
|
OptionConfigKey(ConfigMeta meta,
Class<T> clazz,
T[] options,
T dflt)
Constructor that specifies an explicit default and uses the default specifier type. |
|
OptionConfigKey(ConfigMeta meta,
Class<T> clazz,
T[] options,
T dflt,
boolean useRadio)
Constructor that specifies an explicit default and specifier type. |
Method Summary | |
---|---|
OptionConfigKey<T> |
addOptionsXml()
Convenience method to add the result of getOptionsXml()
to the XML documentation of this key. |
Specifier<T> |
createSpecifier()
Constructs a graphical control with which the user can specify a suitable value for association with this key. |
T[] |
getOptions()
Returns the available options for this key. |
String |
getOptionsXml()
Returns an XML list of the available options for this config key. |
abstract String |
getXmlDescription(T value)
Returns a description in XML of the given option value. |
OptionConfigKey<T> |
setOptionUsage()
Sets the usage string based on the currently configured options. |
T |
stringToValue(String txt)
Calls valueToString repeatedly looking for a match. |
String |
valueToString(T value)
Invokes the toString method of the supplied option. |
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 OptionConfigKey(ConfigMeta meta, Class<T> clazz, T[] options, T dflt, boolean useRadio)
meta
- metadataclazz
- class to which all the possible options belongoptions
- array of possible values for this keydflt
- default option, should be one of options
useRadio
- true to use radio buttons, false for a combo boxpublic OptionConfigKey(ConfigMeta meta, Class<T> clazz, T[] options, T dflt)
meta
- metadataclazz
- class to which all the possible options belongoptions
- array of possible values for this keydflt
- default option, should be one of options
public OptionConfigKey(ConfigMeta meta, Class<T> clazz, T[] options)
meta
- metadataclazz
- class to which all the possible options belongoptions
- array of possible values for this key,
first element is used as the default valueMethod Detail |
---|
public String valueToString(T value)
toString
method of the supplied option.
May be overridden.
valueToString
in class ConfigKey<T>
value
- possible value associated with this key
public abstract String getXmlDescription(T value)
valueToString(T)
,
is used by the getOptionsXml()
method to assemble
a described list of the options.
value
- possible value of this key
public T stringToValue(String txt) throws ConfigException
valueToString
repeatedly looking for a match.
This means that if valueToString
is overridden it
is usually not necessary to override this method.
stringToValue
in class ConfigKey<T>
txt
- string representation of value
ConfigException
public T[] getOptions()
public Specifier<T> createSpecifier()
ConfigKey
createSpecifier
in class ConfigKey<T>
public OptionConfigKey<T> setOptionUsage()
public OptionConfigKey<T> addOptionsXml()
getOptionsXml()
to the XML documentation of this key.
public String getOptionsXml()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |