/*
* $Id: AbstractTool.java 49 2007-05-19 19:24:42Z chammer $
* Copyright (c) 2005-2007 Bruno Lowagie, Carsten Hammer
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
/*
* This class was originally published under the MPL by Bruno Lowagie
* and Carsten Hammer.
* It was a part of iText, a Java-PDF library. You can now use it under
* the MIT License; for backward compatibility you can also use it under
* the MPL version 1.1: http://www.mozilla.org/MPL/
* A copy of the MPL license is bundled with the source code FYI.
*/
package com.lowagie.tools;
import java.awt.Desktop;
import java.awt.event.*;
import java.io.File;
import java.util.ArrayList;
import java.util.Iterator;
import javax.swing.*;
import com.lowagie.tools.arguments.StringArgument;
/**
* Every iText tool has to extend this abstract class.
*
* @author not attributable
* @version Id
*/
public abstract class AbstractTool implements ToolMenuItems, ActionListener {
/** An array with the plugin_versions of the tool. */
public static ArrayList versionsarray = new ArrayList();
/** The internal frame of the tool. */
protected JInternalFrame internalFrame = null;
/** The list of arguments needed by the tool. */
protected ArrayList arguments = new ArrayList();
/** Execute menu options */
protected int menuoptions = MENU_EXECUTE;
/** a menu option */
public static final int MENU_EXECUTE = 1;
/** a menu option */
public static final int MENU_EXECUTE_SHOW = 2;
/** a menu option */
public static final int MENU_EXECUTE_PRINT = 4;
/** a menu option */
public static final int MENU_EXECUTE_PRINT_SILENT = 8;
/**
* awtdesktop
*/
private Desktop awtdesktop = null;
private JMenuBar menubar;
/**
* AbstractTool
*/
public AbstractTool(){
if (Desktop.isDesktopSupported()) {
awtdesktop = Desktop.getDesktop();
}
}
/**
* Sets the arguments.
* @param arguments The arguments to set.
*/
public void setArguments(ArrayList arguments) {
this.arguments = arguments;
}
/**
* Sets the arguments.
* @param args the arguments as String-array.
*/
public void setMainArguments(String[] args) {
int counter = 0;
StringArgument argument;
for (Iterator i = arguments.iterator(); i.hasNext(); ) {
argument = (StringArgument) i.next();
if (args.length > counter) {
argument.setValue(args[counter]);
}
else {
break;
}
counter++;
}
}
/**
* Gets the arguments.
* @return Returns the arguments.
*/
public ArrayList getArguments() {
return arguments;
}
/**
* Gets the value of a given argument.
*
* @param name the name of the argument
* @return the value of an argument as an Object.
* @throws InstantiationException
*/
public Object getValue(String name) throws InstantiationException {
StringArgument argument;
for (Iterator i = arguments.iterator(); i.hasNext(); ) {
argument = (StringArgument) i.next();
if (name.equals(argument.getName())) {
return argument.getArgument();
}
}
return null;
}
/**
* Sets the internal frame.
* @param internalFrame The internalFrame to set.
*/
public void setInternalFrame(JInternalFrame internalFrame) {
this.internalFrame = internalFrame;
}
public void setMenubar(JMenuBar menubar) {
this.menubar = menubar;
}
/**
* Returns the internal frame. Creates one if it's null.
* @return Returns the internalFrame.
*/
public JInternalFrame getInternalFrame() {
if (internalFrame == null) {
createFrame();
}
return internalFrame;
}
/**
* Gets the menubar.
* @return a menubar for this tool
*/
public JMenuBar getMenubar() {
menubar = new JMenuBar();
JMenu tool = new JMenu(TOOL);
tool.setMnemonic(KeyEvent.VK_F);
JMenuItem usage = new JMenuItem(USAGE);
usage.setMnemonic(KeyEvent.VK_U);
usage.addActionListener(this);
tool.add(usage);
JMenuItem args = new JMenuItem(ARGUMENTS);
args.setMnemonic(KeyEvent.VK_A);
args.addActionListener(this);
tool.add(args);
if ((menuoptions & MENU_EXECUTE) > 0) {
JMenuItem execute = new JMenuItem(EXECUTE);
execute.setMnemonic(KeyEvent.VK_E);
execute.addActionListener(this);
tool.add(execute);
}
if ((menuoptions & MENU_EXECUTE_SHOW) > 0) {
JMenuItem execute = new JMenuItem(EXECUTESHOW);
execute.addActionListener(this);
tool.add(execute);
}
if ((menuoptions & MENU_EXECUTE_PRINT) > 0) {
JMenuItem execute = new JMenuItem(EXECUTEPRINT);
execute.addActionListener(this);
tool.add(execute);
}
if ((menuoptions & MENU_EXECUTE_PRINT_SILENT) > 0) {
JMenuItem execute = new JMenuItem(EXECUTEPRINTSILENT);
execute.addActionListener(this);
tool.add(execute);
}
JMenuItem close = new JMenuItem(CLOSE);
close.setMnemonic(KeyEvent.VK_C);
close.addActionListener(this);
tool.add(close);
menubar.add(tool);
if (!arguments.isEmpty()) {
JMenu params = new JMenu(ARGUMENTS);
tool.setMnemonic(KeyEvent.VK_T);
JMenuItem item;
StringArgument argument;
for (Iterator i = arguments.iterator(); i.hasNext(); ) {
argument = (StringArgument)i.next();
item = new JMenuItem(argument.getName());
item.setToolTipText(argument.getDescription());
item.addActionListener(argument);
params.add(item);
}
menubar.add(params);
}
return menubar;
}
/**
* Gets the usage of the tool.
* @return a String describing how to use the tool.
*/
public String getUsage() {
StringBuffer buf = new StringBuffer("java ");
buf.append(getClass().getName());
StringArgument argument;
for (Iterator i = arguments.iterator(); i.hasNext(); ) {
argument = (StringArgument) i.next();
buf.append(' ');
buf.append(argument.getName());
}
buf.append('\n');
for (Iterator i = arguments.iterator(); i.hasNext(); ) {
argument = (StringArgument) i.next();
buf.append(argument.getUsage());
}
return buf.toString();
}
/**
* Gets the current arguments of the tool.
* @return a String with the list of arguments and their values.
*/
private String getArgs() {
StringBuffer buf = new StringBuffer("Current arguments:\n");
StringArgument argument;
for (Iterator i = arguments.iterator(); i.hasNext(); ) {
argument = (StringArgument) i.next();
buf.append(" ");
buf.append(argument.getName());
if (argument.getValue() == null) {
buf.append(" = null\n");
}
else {
buf.append(" = '");
buf.append(argument.getValue());
buf.append("'\n");
}
}
return buf.toString();
}
/**
*
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
* @param evt ActionEvent
*/
public void actionPerformed(ActionEvent evt) {
if (CLOSE.equals(evt.getActionCommand())) {
System.out.println("=== " + getInternalFrame().getTitle() + " CLOSED ===");
internalFrame.dispose();
}
if (USAGE.equals(evt.getActionCommand())) {
JOptionPane.showMessageDialog(internalFrame, getUsage());
}
if (ARGUMENTS.equals(evt.getActionCommand())) {
JOptionPane.showMessageDialog(internalFrame, getArgs());
}
if (EXECUTE.equals(evt.getActionCommand())) {
this.execute();
}
if (EXECUTESHOW.equals(evt.getActionCommand())) {
this.execute();
try {
if (awtdesktop!=null&&awtdesktop.isSupported(Desktop.Action.OPEN)) {
awtdesktop.open(getDestPathPDF());
}else{
Executable.openDocument(getDestPathPDF());
}
} catch (Exception e) {
System.err.println(e.getMessage());
}
}
if (EXECUTEPRINT.equals(evt.getActionCommand())) {
this.execute();
try {
if (awtdesktop!=null&&awtdesktop.isSupported(Desktop.Action.PRINT)) {
awtdesktop.print(getDestPathPDF());
}else{
Executable.printDocument(getDestPathPDF());
}
} catch (Exception e) {
System.err.println(e.getMessage());
}
}
if (EXECUTEPRINTSILENT.equals(evt.getActionCommand())) {
this.execute();
try {
Executable.printDocumentSilent(getDestPathPDF());
} catch (Exception e) {
System.err.println(e.getMessage());
}
}
}
/**
* Gets the PDF file that should be generated (or null if the output isn't a PDF file).
* @return the PDF file that should be generated
* @throws InstantiationException
*/
protected abstract File getDestPathPDF() throws InstantiationException;
/**
* Creates the internal frame.
*/
protected abstract void createFrame();
/**
* Executes the tool (in most cases this generates a PDF file).
*/
public abstract void execute();
/**
* Indicates that the value of an argument has changed.
* @param arg the argument that has changed
*/
public abstract void valueHasChanged(StringArgument arg);
/**
* Add the version of the plugin to the plugin_versions array.
* @param version the version to add.
*/
protected static void addVersion(String version) {
version = version.substring(5, version.length() - 2);
versionsarray.add(version);
}
}