com.jasperassistant.designer.viewer.actions
Class AbstractExportAction

java.lang.Object
  extended byorg.eclipse.jface.action.Action
      extended bycom.jasperassistant.designer.viewer.actions.AbstractReportViewerAction
          extended bycom.jasperassistant.designer.viewer.actions.AbstractExportAction
All Implemented Interfaces:
java.util.EventListener, org.eclipse.jface.action.IAction, IReportViewerListener
Direct Known Subclasses:
ExportAsCsvAction, ExportAsHtmlAction, ExportAsJasperReportsAction, ExportAsMultiXlsAction, ExportAsPdfAction, ExportAsRtfAction, ExportAsSingleXlsAction, ExportAsXmlAction, ExportAsXmlWithImagesAction

public abstract class AbstractExportAction
extends AbstractReportViewerAction

Base class for export actions

Author:
Peter Severin (peter_p_s@users.sourceforge.net)

Field Summary
 
Fields inherited from interface org.eclipse.jface.action.IAction
AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
AbstractExportAction(IReportViewer viewer)
           
AbstractExportAction(IReportViewer viewer, int style)
           
 
Method Summary
protected  boolean calculateEnabled()
          Calculates the enablement condition
protected  void export(java.io.File file)
          Subclasses can override this method to implement an export method.
protected  void exportWithProgress(java.io.File file, net.sf.jasperreports.engine.export.JRExportProgressMonitor monitor)
          Subclasses should override this method to implement a progress monitor aware export method.
 java.lang.String getDefaultFileExtension()
           
 java.lang.String getFileName()
           
 java.lang.String getFilterPath()
           
 void run()
           
 void setDefaultFileExtension(java.lang.String defaultFileExtension)
           
 void setFileExtensions(java.lang.String[] fileExtensions)
           
 void setFileName(java.lang.String fileName)
           
 void setFilterNames(java.lang.String[] filterNames)
           
 void setFilterPath(java.lang.String filterPath)
           
 
Methods inherited from class com.jasperassistant.designer.viewer.actions.AbstractReportViewerAction
dispose, getReportViewer, runBusy, viewerStateChanged
 
Methods inherited from class org.eclipse.jface.action.Action
addPropertyChangeListener, convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, notifyResult, removeAcceleratorText, removeMnemonics, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractExportAction

public AbstractExportAction(IReportViewer viewer)
See Also:
AbstractReportViewerAction.AbstractReportViewerAction(IReportViewer)

AbstractExportAction

public AbstractExportAction(IReportViewer viewer,
                            int style)
See Also:
AbstractExportAction(IReportViewer, int)
Method Detail

run

public void run()
Specified by:
run in interface org.eclipse.jface.action.IAction
Overrides:
run in class AbstractReportViewerAction
See Also:
AbstractReportViewerAction.run()

export

protected void export(java.io.File file)
               throws java.lang.Throwable
Subclasses can override this method to implement an export method. Default implementation opens a progress monitor dialog and then calls the exportWithProgress(File, JRExportProgressMonitor)method.

Parameters:
file - the destination file
Throws:
java.lang.Throwable - if an error occurs during the export
See Also:
exportWithProgress(File, JRExportProgressMonitor)

setDefaultFileExtension

public void setDefaultFileExtension(java.lang.String defaultFileExtension)
Parameters:
defaultFileExtension - The defaultFileExtension to set.

getDefaultFileExtension

public java.lang.String getDefaultFileExtension()

setFileExtensions

public void setFileExtensions(java.lang.String[] fileExtensions)
Parameters:
fileExtensions - The fileExtensions to set.

setFilterNames

public void setFilterNames(java.lang.String[] filterNames)
Parameters:
filterNames - The filterNames to set.

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String fileName)

getFilterPath

public java.lang.String getFilterPath()

setFilterPath

public void setFilterPath(java.lang.String filterPath)

calculateEnabled

protected boolean calculateEnabled()
Description copied from class: AbstractReportViewerAction
Calculates the enablement condition

Specified by:
calculateEnabled in class AbstractReportViewerAction
Returns:
true if the action should be enabled
See Also:
AbstractReportViewerAction.calculateEnabled()

exportWithProgress

protected void exportWithProgress(java.io.File file,
                                  net.sf.jasperreports.engine.export.JRExportProgressMonitor monitor)
                           throws java.lang.Throwable
Subclasses should override this method to implement a progress monitor aware export method.

Parameters:
file - the destination file
monitor - the progress monitor
Throws:
java.lang.Throwable - if an error occurs during the export