com.jrefinery.report.preview
Interface ExportPlugin

All Known Implementing Classes:
AbstractExportPlugin

public interface ExportPlugin

An export plug-in is a class that can work with the ExportAction class to implement an export function for reports.

Author:
Thomas Morgner.

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.
 java.lang.String getFailureDescription()
          Returns an error description for the last operation.
 javax.swing.Icon getLargeIcon()
          Returns the large icon for the export action.
 java.lang.Integer getMnemonicKey()
          Returns the mnemonic key code.
 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.
 

Method Detail

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.

isSeparated

public boolean isSeparated()
Returns true if the action is separated, and false otherwise.

Returns:
A boolean.

isAddToToolbar

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

Returns:
A boolean.

init

public void init(PreviewProxy proxy)
Initializes the plugin to work with the given PreviewProxy.

Parameters:
proxy -

isControlPlugin

public boolean isControlPlugin()
Returns true, when this export plugin is used to configure the report or an other plugin.

Returns:
true if this is a control plugin, false otherwise.

getFailureDescription

public java.lang.String getFailureDescription()
Returns an error description for the last operation.

Returns:
returns a error description.