com.lowagie.tools.arguments

Class OptionArgument

java.lang.Object

com.lowagie.tools.arguments.ToolArgument

com.lowagie.tools.arguments.OptionArgument

All Implemented Interfaces:

java.awt.event.ActionListener, java.beans.PropertyChangeListener, java.util.EventListener

Direct Known Subclasses:

PageSizeArgument

public class OptionArgument
extends ToolArgument

Argument that can be one of several options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OptionArgument.Entry An Entry that can be chosen as option.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.TreeMap	options

Fields inherited from class com.lowagie.tools.arguments.ToolArgument

classname, description, name, propertyChangeListeners, tool, value

Constructor Summary

Constructors

Constructor and Description
OptionArgument(AbstractTool tool, java.lang.String name, java.lang.String description) Constructs an OptionArgument.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent evt)
void	addOption(java.lang.Object description, java.lang.Object value) Adds an Option.
java.lang.Object	getArgument() Gets the argument as an object.
java.lang.String	getUsage() Give you a String that can be used in a usage description.

Methods inherited from class com.lowagie.tools.arguments.ToolArgument

addPropertyChangeListener, firePropertyChange, getClassname, getDescription, getName, getValue, propertyChange, removePropertyChangeListener, setClassname, setDescription, setName, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

options

private java.util.TreeMap options

Constructor Detail

OptionArgument

public OptionArgument(AbstractTool tool,
              java.lang.String name,
              java.lang.String description)

Constructs an OptionArgument.

Parameters:

tool - the tool that needs this argument

name - the name of the argument

description - the description of the argument

Method Detail

addOption

public void addOption(java.lang.Object description,
             java.lang.Object value)

Adds an Option.

Parameters:

description - the description of the option

value - the value of the option

getArgument

public java.lang.Object getArgument()
                             throws java.lang.InstantiationException

Gets the argument as an object.

Overrides:

getArgument in class ToolArgument

Returns:

an object

Throws:

java.lang.InstantiationException

getUsage

public java.lang.String getUsage()

Description copied from class: ToolArgument

Give you a String that can be used in a usage description.

Overrides:

getUsage in class ToolArgument

Returns:

a String

See Also:

ToolArgument.getUsage()

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent evt)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class ToolArgument

See Also:

ActionListener.actionPerformed(java.awt.event.ActionEvent)