Package uk.ac.starlink.ttools.plottask
Class StyleParameter<T>
java.lang.Object
uk.ac.starlink.task.Parameter<T>
uk.ac.starlink.task.AbstractChoiceParameter<T,T>
uk.ac.starlink.task.ChoiceParameter<T>
uk.ac.starlink.ttools.plottask.StyleParameter<T>
- Direct Known Subclasses:
FontParameter
,ShaderParameter
public class StyleParameter<T>
extends uk.ac.starlink.task.ChoiceParameter<T>
ChoiceParameter subclass suitable for use with plotting style configuration.
Adds a few useful customisations.
- Since:
- 8 Aug 2008
- Author:
- Mark Taylor
-
Field Summary
Fields inherited from class uk.ac.starlink.task.Parameter
BY_NAME
-
Constructor Summary
ConstructorsConstructorDescriptionStyleParameter
(String name, Class<T> clazz) Constructs a StyleParameter without initialising any options.StyleParameter
(String name, T[] options) Constructs a StyleParameter with a given list of options. -
Method Summary
Modifier and TypeMethodDescriptionReturns a formatted XML string giving an unordered list of the options for this parameter.getUsage()
void
stringifyOption
(T option) Methods inherited from class uk.ac.starlink.task.ChoiceParameter
objectToString, setDefaultOption, stringToObject
Methods inherited from class uk.ac.starlink.task.AbstractChoiceParameter
addOption, addOption, choiceToString, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, stringToChoice
Methods inherited from class uk.ac.starlink.task.Parameter
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString
-
Constructor Details
-
StyleParameter
Constructs a StyleParameter with a given list of options.- Parameters:
name
- parameter nameoptions
- list of options
-
StyleParameter
Constructs a StyleParameter without initialising any options.- Parameters:
name
- parameter name
-
-
Method Details
-
setUsage
- Overrides:
setUsage
in classuk.ac.starlink.task.ChoiceParameter<T>
-
getUsage
- Overrides:
getUsage
in classuk.ac.starlink.task.ChoiceParameter<T>
-
getOptionList
Returns a formatted XML string giving an unordered list of the options for this parameter. Suitable for insertion into a parameter description. Not enclosed in a <p> element.- Returns:
- option list XML string
-
stringifyOption
-