|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<T>
uk.ac.starlink.task.ChoiceParameter<PaintMode>
uk.ac.starlink.ttools.plottask.PaintModeParameter
public class PaintModeParameter
Parameter which obtains a Painter object.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
PaintModeParameter(String name,
GraphicExporter[] exporters)
Constructor. |
Method Summary | |
---|---|
ChoiceParameter<GraphicExporter> |
getFormatParameter()
Returns the parameter giving the graphics format to use. |
OutputStreamParameter |
getOutputParameter()
Returns the parameter determining the output stream (if any) to use for the graphics output. |
Painter |
painterValue(Environment env)
Returns the value of this parameter as a Painter object. |
void |
setValueFromPainter(Environment env,
Painter painter)
Sets the value for this parameter directly from a painter object. |
Methods inherited from class uk.ac.starlink.task.ChoiceParameter |
---|
addOption, addOption, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, getUsage, objectToString, setDefaultOption, setUsage, stringifyOption, stringToObject |
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PaintModeParameter(String name, GraphicExporter[] exporters)
name
- parameter nameexporters
- list of graphic exporters for file output optionsMethod Detail |
---|
public OutputStreamParameter getOutputParameter()
public ChoiceParameter<GraphicExporter> getFormatParameter()
public void setValueFromPainter(Environment env, Painter painter) throws TaskException
painter
- value for parameter
TaskException
public Painter painterValue(Environment env) throws TaskException
env
- execution environment
TaskException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |