Package org.jfree.report.modules.gui.swing.common

Class AbstractExportDialog

java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Dialog
javax.swing.JDialog
org.jfree.report.modules.gui.swing.common.AbstractExportDialog
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, ExportDialog
Direct Known Subclasses:
HtmlFileExportDialog, HtmlZipExportDialog, PdfExportDialog
public abstract class AbstractExportDialog extends JDialog implements ExportDialog
See Also:

  • Constructor Details

    • AbstractExportDialog

      public AbstractExportDialog()
      Creates a non-modal dialog without a title and without a specified Frame owner. A shared, hidden frame will be set as the owner of the dialog.

    • AbstractExportDialog

      public AbstractExportDialog(Frame owner)
      Creates a non-modal dialog without a title with the specified Frame as its owner. If owner is null, a shared, hidden frame will be set as the owner of the dialog.
      Parameters:
      owner - the Frame from which the dialog is displayed

    • AbstractExportDialog

      public AbstractExportDialog(Dialog owner)
      Creates a non-modal dialog without a title with the specified Dialog as its owner.
      Parameters:
      owner - the non-null Dialog from which the dialog is displayed

  • Method Details

    • getStatusBar

      public abstract JStatusBar getStatusBar()

    • getCancelAction

      protected Action getCancelAction()

    • setCancelAction

      protected void setCancelAction(Action cancelAction)

    • getConfirmAction

      protected Action getConfirmAction()

    • setConfirmAction

      protected void setConfirmAction(Action confirmAction)

    • performValidate

      protected abstract boolean performValidate()

    • getFormValidator

      protected FormValidator getFormValidator()

    • initializeFromJob

      protected abstract void initializeFromJob(ReportJob job, GuiContext guiContext)

    • getReportJob

      protected ReportJob getReportJob()

    • getGuiContext

      protected GuiContext getGuiContext()

    • performQueryForExport

      public boolean performQueryForExport(ReportJob reportJob, GuiContext guiContext)
      Opens the dialog to query all necessary input from the user. This will not start the processing, as this is done elsewhere.
      Specified by:
      performQueryForExport in interface ExportDialog
      Parameters:
      reportJob - the report that should be processed.
      Returns:
      true, if the processing should continue, false otherwise.

    • getConfigurationPrefix

      protected abstract String getConfigurationPrefix()

    • grabDialogContents

      protected abstract org.pentaho.reporting.libraries.base.config.Configuration grabDialogContents(boolean full)
      Returns a new (and not connected to the default config from the job) configuration containing all properties from the dialog.
      Parameters:
      full -
      Returns:

    • setDialogContents

      protected abstract void setDialogContents(org.pentaho.reporting.libraries.base.config.Configuration properties)

    • getConfigurationSuffix

      protected abstract String getConfigurationSuffix()

    • getResources

      protected ResourceBundle getResources()
      Retrieves the resources for this dialog. If the resources are not initialized, they get loaded on the first call to this method.
      Returns:
      this frames ResourceBundle.

    • isInputStorageEnabled

      protected boolean isInputStorageEnabled(org.pentaho.reporting.libraries.base.config.Configuration config)

    • isFullInputStorageEnabled

      protected boolean isFullInputStorageEnabled(org.pentaho.reporting.libraries.base.config.Configuration config)

    • isConfirmed

      public boolean isConfirmed()
      Returns true if the user confirmed the selection, and false otherwise. The file should only be saved if the result is true.
      Returns:
      A boolean.

    • setConfirmed

      protected void setConfirmed(boolean confirmed)
      Defines whether this dialog has been finished using the 'OK' or the 'Cancel' option.
      Parameters:
      confirmed - set to true, if OK was pressed, false otherwise

    • performConfirm

      protected boolean performConfirm()

    • clear

      public abstract void clear()

    • getResourceBaseName

      protected abstract String getResourceBaseName()

    • resolvePath

      protected File resolvePath(String baseDirectory)
      Resolves file names for the exports. An occurence of "~/" at the beginning of the name will be replaced with the users home directory.
      Parameters:
      baseDirectory - the base directory as specified in the configuration.
      Returns:
      the file object pointing to that directory.
      Throws:
      IllegalArgumentException - if the base directory is null.