uk.ac.starlink.ttools.plottask
Class StyleParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter
      extended by uk.ac.starlink.task.ChoiceParameter
          extended by uk.ac.starlink.ttools.plottask.StyleParameter
Direct Known Subclasses:
FontParameter, ShaderParameter

public class StyleParameter
extends uk.ac.starlink.task.ChoiceParameter

ChoiceParameter subclass suitable for use with plotting style configuration. Adds a few useful customisations.

Since:
8 Aug 2008
Author:
Mark Taylor

Constructor Summary
StyleParameter(String name)
          Constructs a StyleParameter without initialising any options.
StyleParameter(String name, Object[] options)
          Constructs a StyleParameter with a given list of options.
 
Method Summary
 String getName(Object option)
           
 String getOptionList()
          Returns a formatted XML string giving an unordered list of the options for this parameter.
 String getUsage()
           
 void setUsage(String usage)
           
 
Methods inherited from class uk.ac.starlink.task.ChoiceParameter
addOption, addOption, getOption, getOptionNames, getOptions, objectValue, setDefaultOption, 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

StyleParameter

public StyleParameter(String name,
                      Object[] options)
Constructs a StyleParameter with a given list of options.

Parameters:
name - parameter name
options - list of options

StyleParameter

public StyleParameter(String name)
Constructs a StyleParameter without initialising any options.

Parameters:
name - parameter name
Method Detail

setUsage

public void setUsage(String usage)
Overrides:
setUsage in class uk.ac.starlink.task.ChoiceParameter

getUsage

public String getUsage()
Overrides:
getUsage in class uk.ac.starlink.task.ChoiceParameter

getOptionList

public String 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

getName

public String getName(Object option)
Overrides:
getName in class uk.ac.starlink.task.ChoiceParameter


Copyright © 2009 Central Laboratory of the Research Councils. All Rights Reserved.