com.lowagie.toolbox

Class AbstractTool

java.lang.Object

com.lowagie.toolbox.AbstractTool

All Implemented Interfaces:

ActionListener, EventListener

Direct Known Subclasses:

Add3D, Bookmarks2XML, Burst, CompressDecompressPageContent, Concat, ConcatN, Decrypt, Divide, DvdCover, Encrypt, ExtractAttachments, Handouts, HtmlBookmarks, ImageXRefViewer, InspectPDF, Normalize, NUp, PhotoAlbum, RemoveLaunchApplication, ReversePages, SelectedPages, Split, Txt2Pdf, WatermarkerTool, XML2Bookmarks

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

Fields

Modifier and Type	Field and Description
protected ArrayList<AbstractArgument>	arguments The list of arguments needed by the tool.
protected JInternalFrame	internalFrame The internal frame of the tool.
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
protected int	menuoptions Execute menu options
static ArrayList<String>	versionsarray An array with the plugin_versions of the tool.

Constructor Summary

Constructors

Constructor and Description
AbstractTool() AbstractTool

Method Summary

Modifier and Type	Method and Description
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).
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.

Methods inherited from class java.lang.Object

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

Field Detail

versionsarray

public static ArrayList<String> versionsarray

An array with the plugin_versions of the tool.

internalFrame

protected JInternalFrame internalFrame

The internal frame of the tool.

arguments

protected ArrayList<AbstractArgument> arguments

The list of arguments needed by the tool.

menuoptions

protected int menuoptions

Execute menu options

MENU_EXECUTE

public static final int MENU_EXECUTE

a menu option

See Also:

Constant Field Values

MENU_EXECUTE_SHOW

public static final int MENU_EXECUTE_SHOW

a menu option

See Also:

Constant Field Values

MENU_EXECUTE_PRINT

public static final int MENU_EXECUTE_PRINT

a menu option

See Also:

Constant Field Values

MENU_EXECUTE_PRINT_SILENT

public static final int MENU_EXECUTE_PRINT_SILENT

a menu option

See Also:

Constant Field Values

Constructor Detail

AbstractTool

public AbstractTool()

AbstractTool

Method Detail

setArguments

public void setArguments(ArrayList<AbstractArgument> arguments)

Sets the arguments.

Parameters:

arguments - The arguments to set.

setMainArguments

public void setMainArguments(String[] args)

Sets the arguments.

Parameters:

args - the arguments as String-array.

getArguments

public ArrayList<AbstractArgument> getArguments()

Gets the arguments.

Returns:

Returns the arguments.

getValue

public Object getValue(String name)
                throws InstantiationException

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

setInternalFrame

public void setInternalFrame(JInternalFrame internalFrame)

Sets the internal frame.

Parameters:

internalFrame - The internalFrame to set.

setMenubar

public void setMenubar(JMenuBar menubar)

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.

actionPerformed

public void actionPerformed(ActionEvent evt)

Specified by:

actionPerformed in interface ActionListener

Parameters:

evt - ActionEvent

See Also:

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

getDestPathPDF

protected abstract File getDestPathPDF()
                                throws InstantiationException

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

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).

valueHasChanged

public abstract void valueHasChanged(AbstractArgument arg)

Indicates that the value of an argument has changed.

Parameters:

arg - the argument that has changed

addVersion

protected static void addVersion(String version)

Add the version of the plugin to the plugin_versions array.

Parameters:

version - the version to add.