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

java.lang.Object
  org.jfree.report.modules.gui.base.AbstractExportPlugin
      org.jfree.report.modules.gui.print.PageSetupPlugin

All Implemented Interfaces:

ExportPlugin

public class PageSetupPlugin

extends AbstractExportPlugin

An export control plugin that handles the setup of page format objects for the report.

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.

Constructor Summary

PageSetupPlugin()
Default Constructor.

Method Summary

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 to be used to translate strings into localized content.
java.lang.String	getShortDescription() Returns the short description for the export action.
javax.swing.Icon	getSmallIcon() Returns the small icon for the export action.
void	init(PreviewProxy proxy) Initializes the plugin to work with the given PreviewProxy.
boolean	isAddToToolbar() Returns true if the action should be added to the toolbar, and false otherwise.
boolean	isControlPlugin() Returns true, when this export plugin is used to configure the report or an other plugin.
boolean	isSeparated() Returns true if the action is separated, and false otherwise.
boolean	performExport(JFreeReport report) Exports a report.
protected void	updateReportPane()

Methods inherited from class org.jfree.report.modules.gui.base.AbstractExportPlugin

addPropertyChangeListener, addPropertyChangeListener, createProgressDialog, defineWorkerPool, delegateTask, getBase, getFailureDescription, getPropertyChangeSupport, getProxy, handleExportResult, handleExportResult, 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.

Constructor Detail

PageSetupPlugin

public PageSetupPlugin()

Default Constructor.

Method Detail

init

public void init(PreviewProxy proxy)

Initializes the plugin to work with the given PreviewProxy.

Specified by:

init in interface ExportPlugin

Overrides:

init in class AbstractExportPlugin

Parameters:

proxy - the preview proxy that created this plugin.

Throws:

java.lang.NullPointerException - if the proxy or the proxy's basecomponent is null.

isControlPlugin

public boolean isControlPlugin()

Returns true, when this export plugin is used to configure the report or an other plugin.

Specified by:

isControlPlugin in interface ExportPlugin

Overrides:

isControlPlugin in class AbstractExportPlugin

Returns:

true if this is a control plugin, false otherwise.

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.

getResources

protected java.util.ResourceBundle getResources()

Returns the resourcebundle to be used to translate strings into localized content.

Returns:

the resourcebundle for the localisation.

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.

updateReportPane

protected void updateReportPane()