Package org.pentaho.reporting.engine.classic.core.modules.gui.pdf

Class PdfExportPlugin

java.lang.Object

org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.AbstractActionPlugin

org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.AbstractExportActionPlugin

org.pentaho.reporting.engine.classic.core.modules.gui.pdf.PdfExportPlugin

All Implemented Interfaces:

ActionPlugin, ExportActionPlugin

public class PdfExportPlugin
extends AbstractExportActionPlugin

Encapsulates the PDF export into a separate export plugin.

Author:

Thomas Morgner

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_RESOURCE_CLASS	The base resource class.
static String	PROGRESS_DIALOG_ENABLE_KEY

Fields inherited from class org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.AbstractActionPlugin

ENABLED_PROPERTY

Constructor Summary

Constructors

Constructor	Description
PdfExportPlugin()	DefaultConstructor.

Method Summary

Modifier and Type	Method	Description
protected ReportProgressDialog	createProgressDialog()	Creates the progress dialog that monitors the export process.
KeyStroke	getAcceleratorKey()	Returns the accelerator key for the action.
protected String	getConfigurationPrefix()
String	getDisplayName()	Returns the display name.
Icon	getLargeIcon()	Returns the large icon for the action.
Integer	getMnemonicKey()	Returns the mnemonic key code.
protected org.pentaho.reporting.libraries.base.util.ResourceBundleSupport	getResources()	Returns the resourcebundle to be used to translate strings into localized content.
String	getShortDescription()	Returns the short description for the action.
Icon	getSmallIcon()	Returns the small icon for the action.
boolean	initialize(SwingGuiContext context)
boolean	performExport(MasterReport report)	Shows this dialog and (if the dialog is confirmed) saves the complete report into an PDF file.

Methods inherited from class org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.AbstractExportActionPlugin

createExportDialog, deinitialize, isProgressDialogEnabled, performShowExportDialog

Methods inherited from class org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.AbstractActionPlugin

addPropertyChangeListener, addPropertyChangeListener, getBaseResources, getConfig, getContext, getIconTheme, getMenuOrder, getPropertyChangeSupport, getRole, getRolePreference, getToolbarOrder, isAddToMenu, isAddToToolbar, isEnabled, isSeparated, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.ActionPlugin

addPropertyChangeListener, addPropertyChangeListener, getMenuOrder, getRole, getRolePreference, getToolbarOrder, isAddToMenu, isAddToToolbar, isEnabled, isSeparated, removePropertyChangeListener

Field Detail

BASE_RESOURCE_CLASS

public static final String BASE_RESOURCE_CLASS

The base resource class.

See Also:

Constant Field Values

PROGRESS_DIALOG_ENABLE_KEY

public static final String PROGRESS_DIALOG_ENABLE_KEY

See Also:

Constant Field Values

Constructor Detail

PdfExportPlugin

public PdfExportPlugin()

DefaultConstructor.

Method Detail

getConfigurationPrefix

protected String getConfigurationPrefix()

Specified by:

getConfigurationPrefix in class AbstractActionPlugin

initialize

public boolean initialize(SwingGuiContext context)

Specified by:

initialize in interface ActionPlugin

Overrides:

initialize in class AbstractExportActionPlugin

createProgressDialog

protected ReportProgressDialog createProgressDialog()

Creates the progress dialog that monitors the export process.

Overrides:

createProgressDialog in class AbstractActionPlugin

Returns:

the progress monitor dialog.

performExport

public boolean performExport(MasterReport report)

Shows this dialog and (if the dialog is confirmed) saves the complete report into an PDF file.

Parameters:

report - the report being processed.

Returns:

true or false.

getDisplayName

public String getDisplayName()

Returns the display name.

Returns:

The display name.

getShortDescription

public String getShortDescription()

Returns the short description for the action.

Returns:

The short description.

getSmallIcon

public Icon getSmallIcon()

Returns the small icon for the action.

Returns:

The icon.

getLargeIcon

public Icon getLargeIcon()

Returns the large icon for the action.

Returns:

The icon.

getAcceleratorKey

public KeyStroke getAcceleratorKey()

Returns the accelerator key for the action.

Returns:

The accelerator key.

getMnemonicKey

public Integer getMnemonicKey()

Returns the mnemonic key code.

Returns:

The key code.

getResources

protected org.pentaho.reporting.libraries.base.util.ResourceBundleSupport getResources()

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

Returns:

the resourcebundle for the localization.