org.jfree.report.modules.gui.print
Class PrintingPlugin

java.lang.Object
  extended byorg.jfree.report.modules.gui.base.AbstractExportPlugin
      extended byorg.jfree.report.modules.gui.print.PrintingPlugin
All Implemented Interfaces:
ExportPlugin

public class PrintingPlugin
extends AbstractExportPlugin

An export plugin for the java.awt.print API.

Author:
Thomas Morgner

Nested Class Summary
 
Nested classes inherited from class org.jfree.report.modules.gui.base.AbstractExportPlugin
AbstractExportPlugin.DefaultExportTaskListener
 
Field Summary
static java.lang.String BASE_RESOURCE_CLASS
          The base resource class.
static java.lang.String PROGRESS_DIALOG_ENABLE_KEY
           
 
Constructor Summary
PrintingPlugin()
          DefaultConstructor.
 
Method Summary
protected  ReportProgressDialog createProgressDialog()
          Creates the progress dialog that monitors the export process.
 javax.swing.KeyStroke getAcceleratorKey()
          Returns the accelerator key for the export action.
 java.lang.String getDisplayName()
          Returns the display name for the export action.
 javax.swing.Icon getLargeIcon()
          Returns the large icon for the export action.
 java.lang.Integer getMnemonicKey()
          Returns the mnemonic key code.
protected  java.util.ResourceBundle getResources()
          Returns the resourcebundle used to translate strings.
 java.lang.String getShortDescription()
          Returns the short description for the export action.
 javax.swing.Icon getSmallIcon()
          Returns the small icon for the export action.
 boolean isAddToToolbar()
          Returns true if the action should be added to the toolbar, and false otherwise.
 boolean isSeparated()
          Returns true if the action is separated, and false otherwise.
 boolean performExport(JFreeReport report)
          Exports a report.
 
Methods inherited from class org.jfree.report.modules.gui.base.AbstractExportPlugin
addPropertyChangeListener, addPropertyChangeListener, defineWorkerPool, delegateTask, getBase, getFailureDescription, getPropertyChangeSupport, getProxy, handleExportResult, handleExportResult, init, isControlPlugin, isEnabled, removePropertyChangeListener, setEnabled, updateStatusText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BASE_RESOURCE_CLASS

public static final java.lang.String BASE_RESOURCE_CLASS
The base resource class.


PROGRESS_DIALOG_ENABLE_KEY

public static final java.lang.String PROGRESS_DIALOG_ENABLE_KEY
See Also:
Constant Field Values
Constructor Detail

PrintingPlugin

public PrintingPlugin()
DefaultConstructor.

Method Detail

getResources

protected java.util.ResourceBundle getResources()
Returns the resourcebundle used to translate strings.

Returns:
the resourcebundle.

createProgressDialog

protected ReportProgressDialog createProgressDialog()
Creates the progress dialog that monitors the export process.

Overrides:
createProgressDialog in class AbstractExportPlugin
Returns:
the progress monitor dialog.

performExport

public boolean performExport(JFreeReport report)
Exports a report.

Parameters:
report - the report.
Returns:
A boolean.

getDisplayName

public java.lang.String getDisplayName()
Returns the display name for the export action.

Returns:
The display name.

getShortDescription

public java.lang.String getShortDescription()
Returns the short description for the export action.

Returns:
The short description.

getSmallIcon

public javax.swing.Icon getSmallIcon()
Returns the small icon for the export action.

Returns:
The icon.

getLargeIcon

public javax.swing.Icon getLargeIcon()
Returns the large icon for the export action.

Returns:
The icon.

getAcceleratorKey

public javax.swing.KeyStroke getAcceleratorKey()
Returns the accelerator key for the export action.

Returns:
The accelerator key.

getMnemonicKey

public java.lang.Integer getMnemonicKey()
Returns the mnemonic key code.

Returns:
The code.

isAddToToolbar

public boolean isAddToToolbar()
Returns true if the action should be added to the toolbar, and false otherwise.

Specified by:
isAddToToolbar in interface ExportPlugin
Overrides:
isAddToToolbar in class AbstractExportPlugin
Returns:
true, if the plugin should be added to the toolbar, false otherwise.

isSeparated

public boolean isSeparated()
Returns true if the action is separated, and false otherwise. A separated action starts a new action group and will be spearated from previous actions on the menu and toolbar.

Specified by:
isSeparated in interface ExportPlugin
Overrides:
isSeparated in class AbstractExportPlugin
Returns:
true, if the action should be separated from previous actions, false otherwise.