public class ColorParameter extends NamedObjectParameter<java.awt.Color>
Constructor and Description |
---|
ColorParameter(java.lang.String name)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
java.awt.Color |
colorValue(uk.ac.starlink.task.Environment env)
Returns the value of this parameter as a Color object.
|
java.awt.Color |
fromString(java.lang.String name)
Translates a string value for this parameter into the object value
which it represents.
|
java.lang.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(java.awt.Color color)
Sets the default value of this parameter to a given color object.
|
java.lang.String |
toString(java.awt.Color option)
Translates a possible option value of this parameter into a string
which represents it as a string value.
|
addOption, getNames, getOptionList, getOptions, getUsage, setDefaultOption, setUsage, stringToObject
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectToString, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString
public ColorParameter(java.lang.String name)
name
- parameter namepublic java.awt.Color colorValue(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException
env
- execution environmentuk.ac.starlink.task.TaskException
public void setDefaultColor(java.awt.Color color)
color
- colourpublic java.lang.String toString(java.awt.Color option)
NamedObjectParameter
toString
in class NamedObjectParameter<java.awt.Color>
option
- object valuepublic java.awt.Color fromString(java.lang.String name)
NamedObjectParameter
The implementation must be such that
fromString(toString(o)).equals(o)
.
fromString
in class NamedObjectParameter<java.awt.Color>
name
- option namepublic java.lang.String getFormatDescription()
Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.