com.lowagie.toolbox

Class AbstractTool

public abstract class AbstractTool extends Object implements ActionListener

Every iText tool has to extend this abstract class.

Since: 2.1.1 (imported from itexttoolbox project)

Version: $Id: AbstractTool.java 3276 2008-04-19 00:32:58Z xlv $

Author: not attributable

Field Summary
protected ArrayList<AbstractArgument>	arguments The list of arguments needed by the tool.
Desktop	awtdesktop awtdesktop
protected JInternalFrame	internalFrame The internal frame of the tool.
JMenuBar	menubar
protected int	menuoptions Execute menu options
static int	MENU_EXECUTE a menu option
static int	MENU_EXECUTE_PRINT a menu option
static int	MENU_EXECUTE_PRINT_SILENT a menu option
static int	MENU_EXECUTE_SHOW a menu option
static ArrayList<String>	versionsarray An array with the plugin_versions of the tool.

Constructor Summary
	AbstractTool() AbstractTool

Method Summary
void	actionPerformed(ActionEvent evt)
protected static void	addVersion(String version) Add the version of the plugin to the plugin_versions array.
protected abstract void	createFrame() Creates the internal frame.
abstract void	execute() Executes the tool (in most cases this generates a PDF file).
String	getArgs() Gets the current arguments of the tool.
ArrayList<AbstractArgument>	getArguments() Gets the arguments.
protected abstract File	getDestPathPDF() Gets the PDF file that should be generated (or null if the output isn't a PDF file).
JInternalFrame	getInternalFrame() Returns the internal frame.
JMenuBar	getMenubar() Gets the menubar.
String	getUsage() Gets the usage of the tool.
Object	getValue(String name) Gets the value of a given argument.
void	setArguments(ArrayList<AbstractArgument> arguments) Sets the arguments.
void	setInternalFrame(JInternalFrame internalFrame) Sets the internal frame.
void	setMainArguments(String[] args) Sets the arguments.
void	setMenubar(JMenuBar menubar)
abstract void	valueHasChanged(AbstractArgument arg) Indicates that the value of an argument has changed.

Field Detail

arguments

protected ArrayList<AbstractArgument> arguments

The list of arguments needed by the tool.

awtdesktop

private Desktop awtdesktop

awtdesktop

internalFrame

protected JInternalFrame internalFrame

The internal frame of the tool.

menubar

private JMenuBar menubar

menuoptions

protected int menuoptions

Execute menu options

MENU_EXECUTE

public static final int MENU_EXECUTE

a menu option

MENU_EXECUTE_PRINT

public static final int MENU_EXECUTE_PRINT

a menu option

MENU_EXECUTE_PRINT_SILENT

public static final int MENU_EXECUTE_PRINT_SILENT

a menu option

MENU_EXECUTE_SHOW

public static final int MENU_EXECUTE_SHOW

a menu option

versionsarray

public static ArrayList<String> versionsarray

An array with the plugin_versions of the tool.

Constructor Detail

AbstractTool

public AbstractTool()

AbstractTool

Method Detail

actionPerformed

public void actionPerformed(ActionEvent evt)

Parameters: evt ActionEvent

See Also: java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)

addVersion

protected static void addVersion(String version)

Add the version of the plugin to the plugin_versions array.

Parameters: version the version to add.

createFrame

protected abstract void createFrame()

Creates the internal frame.

execute

public abstract void execute()

Executes the tool (in most cases this generates a PDF file).

getArgs

private String getArgs()

Gets the current arguments of the tool.

Returns: a String with the list of arguments and their values.

getArguments

public ArrayList<AbstractArgument> getArguments()

Gets the arguments.

Returns: Returns the arguments.

getDestPathPDF

protected abstract File getDestPathPDF()

Gets the PDF file that should be generated (or null if the output isn't a PDF file).

Returns: the PDF file that should be generated

Throws: InstantiationException

getInternalFrame

public JInternalFrame getInternalFrame()

Returns the internal frame. Creates one if it's null.

Returns: Returns the internalFrame.

getMenubar

public JMenuBar getMenubar()

Gets the menubar.

Returns: a menubar for this tool

getUsage

public String getUsage()

Gets the usage of the tool.

Returns: a String describing how to use the tool.

getValue

public Object getValue(String name)

Gets the value of a given argument.

Parameters: name the name of the argument

Returns: the value of an argument as an Object.

Throws: InstantiationException

setArguments

public void setArguments(ArrayList<AbstractArgument> arguments)

Sets the arguments.

Parameters: arguments The arguments to set.

setInternalFrame

public void setInternalFrame(JInternalFrame internalFrame)

Sets the internal frame.

Parameters: internalFrame The internalFrame to set.

setMainArguments

public void setMainArguments(String[] args)

Sets the arguments.

Parameters: args the arguments as String-array.

setMenubar

public void setMenubar(JMenuBar menubar)

valueHasChanged

public abstract void valueHasChanged(AbstractArgument arg)

Indicates that the value of an argument has changed.

Parameters: arg the argument that has changed