uk.ac.starlink.ttools.plottask
Class FontParameter

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
              extended by uk.ac.starlink.ttools.plottask.FontParameter

public class FontParameter
extends StyleParameter

Parameter for font selection.

Since:
12 Aug 2008
Author:
Mark Taylor

Constructor Summary
FontParameter(String name)
          Constructor.
 
Method Summary
 Font fontValue(uk.ac.starlink.task.Environment env)
          Returns the value of this parameter as a font.
 uk.ac.starlink.task.Parameter[] getAssociatedParameters()
          Returns parameters associated with this one which select other font characteristics.
 void setValueFromString(uk.ac.starlink.task.Environment env, String sval)
           
 
Methods inherited from class uk.ac.starlink.ttools.plottask.StyleParameter
getName, getOptionList, getUsage, setUsage
 
Methods inherited from class uk.ac.starlink.task.ChoiceParameter
addOption, addOption, getOption, getOptionNames, getOptions, objectValue, setDefaultOption
 
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

FontParameter

public FontParameter(String name)
Constructor.

Parameters:
name - parameter base name
Method Detail

getAssociatedParameters

public uk.ac.starlink.task.Parameter[] getAssociatedParameters()
Returns parameters associated with this one which select other font characteristics.

Returns:
array of font parameters

setValueFromString

public void setValueFromString(uk.ac.starlink.task.Environment env,
                               String sval)
                        throws uk.ac.starlink.task.TaskException
Overrides:
setValueFromString in class uk.ac.starlink.task.ChoiceParameter
Throws:
uk.ac.starlink.task.TaskException

fontValue

public Font fontValue(uk.ac.starlink.task.Environment env)
               throws uk.ac.starlink.task.TaskException
Returns the value of this parameter as a font.

Parameters:
env - execution environment
Throws:
uk.ac.starlink.task.TaskException


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