uk.ac.starlink.ttools.plottask

Class FontParameter

java.lang.Object

uk.ac.starlink.task.Parameter<T>

uk.ac.starlink.task.AbstractChoiceParameter<T,T>

uk.ac.starlink.task.ChoiceParameter<T>

uk.ac.starlink.ttools.plottask.StyleParameter<String>

uk.ac.starlink.ttools.plottask.FontParameter

public class FontParameter
extends StyleParameter<String>

Parameter for font selection.

Since:

12 Aug 2008

Author:

Mark Taylor

Field Summary

Fields inherited from class uk.ac.starlink.task.Parameter

BY_NAME

Constructor Summary

Constructors

Constructor and Description
FontParameter(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
Font	fontValue(Environment env) Returns the value of this parameter as a font.
Parameter<?>[]	getAssociatedParameters() Returns parameters associated with this one which select other font characteristics.

Methods inherited from class uk.ac.starlink.ttools.plottask.StyleParameter

getOptionList, getUsage, setUsage, stringifyOption

Methods inherited from class uk.ac.starlink.task.ChoiceParameter

objectToString, setDefaultOption, stringToObject

Methods inherited from class uk.ac.starlink.task.AbstractChoiceParameter

addOption, addOption, choiceToString, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, stringToChoice

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

FontParameter

public FontParameter(String name)

Constructor.

Parameters:

name - parameter base name

Method Detail

getAssociatedParameters

public Parameter<?>[] getAssociatedParameters()

Returns parameters associated with this one which select other font characteristics.

Returns:

array of font parameters

fontValue

public Font fontValue(Environment env)
               throws TaskException

Returns the value of this parameter as a font.

Parameters:

env - execution environment

Returns:

font

Throws:

TaskException