|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter
uk.ac.starlink.ttools.plottask.NamedObjectParameter
uk.ac.starlink.ttools.plottask.ColorParameter
public class ColorParameter
Constructor Summary | |
---|---|
ColorParameter(String name)
Constructor. |
Method Summary | |
---|---|
Color |
colorValue(uk.ac.starlink.task.Environment env)
Returns the value of this parameter as a Color object. |
Object |
fromString(String name)
Translates a string value for this parameter into the object value which it represents. |
String |
getFormatDescription()
Returns an XML string, suitable for inclusion in a parameter description, which explains the format of values accepted by this parameter. |
void |
setDefaultColor(Color color)
Sets the default value of this parameter to a given color object. |
String |
toString(Object option)
Translates a possible option value of this parameter into a string which represents it as a string value. |
Methods inherited from class uk.ac.starlink.ttools.plottask.NamedObjectParameter |
---|
addOption, getNames, getOptionList, getOptions, getUsage, objectValue, setDefaultOption, setUsage, setValueFromString |
Methods inherited from class uk.ac.starlink.task.Parameter |
---|
checkGotValue, clearValue, getDefault, getDescription, getName, getPosition, getPreferExplicit, getPrompt, isNullPermitted, setDefault, setDescription, setDescription, setGotValue, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringValue, stringValue, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ColorParameter(String name)
name
- parameter nameMethod Detail |
---|
public Color colorValue(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException
env
- execution environment
uk.ac.starlink.task.TaskException
public void setDefaultColor(Color color)
color
- colourpublic String toString(Object option)
NamedObjectParameter
toString
in class NamedObjectParameter
option
- object value
public Object fromString(String name)
NamedObjectParameter
The implementation must be such that
fromString(toString(o)).equals(o)
.
fromString
in class NamedObjectParameter
name
- option name
public String getFormatDescription()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |