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

Class CSVTableExportPlugin

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.csv.CSVTableExportPlugin

All Implemented Interfaces:

ActionPlugin, ExportActionPlugin

public class CSVTableExportPlugin
extends AbstractExportActionPlugin

Encapsulates the CSVDataExportDialog into a separate plugin.

Author:

Thomas Morgner

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_RESOURCE_CLASS

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

ENABLED_PROPERTY

Constructor Summary

Constructors

Constructor	Description
CSVTableExportPlugin()	DefaultConstructor.

Method Summary

Modifier and Type	Method	Description
protected ReportProgressDialog	createProgressDialog()	Creates the report progress dialog used to monitor the export.
KeyStroke	getAcceleratorKey()	Returns the accelerator key for the action associated with the dialog.
protected String	getConfigurationPrefix()
String	getDisplayName()	Returns the display name for the CSV dialog.
Icon	getLargeIcon()	Returns the large icon for the dialog.
Integer	getMnemonicKey()	Returns the mnemonic key code for the action associated with the dialog.
protected org.pentaho.reporting.libraries.base.util.ResourceBundleSupport	getResources()	Returns the resourcebundle to be used to translate strings into localized content.
String	getShortDescription()	Returns a short description for the CSV dialog.
Icon	getSmallIcon()	Returns the small icon for the dialog.
boolean	initialize(SwingGuiContext context)
boolean	performExport(MasterReport report)	Shows this dialog and (if the dialog is confirmed) saves the complete report into an comma separated values 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

See Also:

Constant Field Values

Constructor Detail

CSVTableExportPlugin

public CSVTableExportPlugin()

DefaultConstructor.

Method Detail

initialize

public boolean initialize(SwingGuiContext context)

Specified by:

initialize in interface ActionPlugin

Overrides:

initialize in class AbstractExportActionPlugin

getConfigurationPrefix

protected String getConfigurationPrefix()

Specified by:

getConfigurationPrefix in class AbstractActionPlugin

createProgressDialog

protected ReportProgressDialog createProgressDialog()

Creates the report progress dialog used to monitor the export.

Overrides:

createProgressDialog in class AbstractActionPlugin

Returns:

the created dialog.

performExport

public boolean performExport(MasterReport report)

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

Parameters:

report - the report being processed.

Returns:

true or false.

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.

getDisplayName

public String getDisplayName()

Returns the display name for the CSV dialog.

Returns:

The name.

getShortDescription

public String getShortDescription()

Returns a short description for the CSV dialog.

Returns:

The description.

getSmallIcon

public Icon getSmallIcon()

Returns the small icon for the dialog.

Returns:

The icon.

getLargeIcon

public Icon getLargeIcon()

Returns the large icon for the dialog.

Returns:

The icon.

getAcceleratorKey

public KeyStroke getAcceleratorKey()

Returns the accelerator key for the action associated with the dialog.

Returns:

The key stroke.

getMnemonicKey

public Integer getMnemonicKey()

Returns the mnemonic key code for the action associated with the dialog.

Returns:

The key code.