org.pentaho.reporting.engine.classic.core.modules.gui.csv
Class CSVDataExportPlugin

java.lang.Object
  extended by org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.AbstractActionPlugin
      extended by org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.AbstractExportActionPlugin
          extended by org.pentaho.reporting.engine.classic.core.modules.gui.csv.CSVDataExportPlugin
All Implemented Interfaces:
ActionPlugin, ExportActionPlugin

public class CSVDataExportPlugin
extends AbstractExportActionPlugin

Encapsulates the CSVDataExportDialog into a separate plugin.

Author:
Thomas Morgner

Field Summary
static String BASE_RESOURCE_CLASS
           
 
Fields inherited from class org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.AbstractActionPlugin
ENABLED_PROPERTY
 
Constructor Summary
CSVDataExportPlugin()
          DefaultConstructor.
 
Method Summary
 KeyStroke getAcceleratorKey()
          Returns the accelerator key for the action associated with the dialog.
 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.
 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
deinitialize, performShowExportDialog
 
Methods inherited from class org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.AbstractActionPlugin
addPropertyChangeListener, addPropertyChangeListener, getBaseResources, getConfig, getContext, getIconTheme, getMenuOrder, getRole, getRolePreference, getToolbarOrder, isAddToMenu, isAddToToolbar, isEnabled, isSeparated, removePropertyChangeListener, setEnabled
 
Methods inherited from class java.lang.Object
equals, 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

CSVDataExportPlugin

public CSVDataExportPlugin()
DefaultConstructor.

Method Detail

initialize

public boolean initialize(SwingGuiContext context)
Specified by:
initialize in interface ActionPlugin
Overrides:
initialize in class AbstractExportActionPlugin

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.

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.