Class OptionArgument

java.lang.Object

org.openpdf.toolbox.arguments.AbstractArgument

org.openpdf.toolbox.arguments.OptionArgument

All Implemented Interfaces:

ActionListener, PropertyChangeListener, EventListener

Direct Known Subclasses:

PageSizeArgument

public class OptionArgument
extends AbstractArgument

Argument that can be one of several options.

Since:

2.1.1 (imported from itexttoolbox project)

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private TreeMap<String, OptionArgument.Entry>	options

Fields inherited from class AbstractArgument

description, name, pcs, tool, value

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class AbstractArgument

addPropertyChangeListener, firePropertyChange, getDescription, getName, getTool, getValue, propertyChange, removePropertyChangeListener, setDescription, setName, setTool, setValue, setValue, toString

Methods inherited from class Object

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

Field Details

options

private TreeMap<String, OptionArgument.Entry> options

Constructor Details

OptionArgument

public OptionArgument(AbstractTool tool,
 String name,
 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 Details

addOption

public void addOption(Object description,
 Object value)

Adds an Option.

Parameters:

description - the description of the option

value - the value of the option

getArgument

public Object getArgument()
                   throws InstantiationException

Gets the argument as an object.

Overrides:

getArgument in class AbstractArgument

Returns:

an object

Throws:

InstantiationException - if the specified key cannot be compared with the keys currently in the map

getUsage

public String getUsage()

Description copied from class: AbstractArgument

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

Overrides:

getUsage in class AbstractArgument

Returns:

String

See Also:

• AbstractArgument.getUsage()

actionPerformed

public void actionPerformed(ActionEvent evt)

Specified by:

actionPerformed in interface ActionListener

Specified by:

actionPerformed in class AbstractArgument

Parameters:

evt - ActionEvent

See Also:

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