org.jfree.report.modules.gui.base.components
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.base.components.AbstractExportDialog

Direct Known Subclasses:

CSVExportDialog, ExcelExportDialog, HtmlExportDialog, PDFSaveDialog, PlainTextExportDialog, RTFExportDialog

public abstract class AbstractExportDialog

extends javax.swing.JDialog

See Also:

Serialized Form

Inner Class Summary

protected class	AbstractExportDialog.AbstractCancelAction Internal action class to cancel the report processing.
protected class	AbstractExportDialog.AbstractConfirmAction Internal action class to confirm the dialog and to validate the input.

Inner classes inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Constructor Summary

AbstractExportDialog()
Creates a non-modal dialog without a title and without a specified Frame owner.

AbstractExportDialog(java.awt.Dialog owner)
Creates a non-modal dialog without a title with the specified Dialog as its owner.

AbstractExportDialog(java.awt.Frame owner)
Creates a non-modal dialog without a title with the specified Frame as its owner.

Method Summary

abstract void	clear()
protected javax.swing.Action	getCancelAction()
protected abstract java.lang.String	getConfigurationPrefix()
protected abstract java.lang.String	getConfigurationSuffix()
protected javax.swing.Action	getConfirmAction()
protected abstract java.util.Properties	getDialogContents(boolean full)
protected FormValidator	getFormValidator()
protected abstract java.lang.String	getResourceBaseName()
protected java.util.ResourceBundle	getResources() Retrieves the resources for this dialog.
JStatusBar	getStatusBar()
protected abstract void	initFromConfiguration(org.jfree.util.Configuration reportConfiguration)
boolean	isConfirmed() Returns true if the user confirmed the selection, and false otherwise.
protected boolean	isFullInputStorageEnabled(org.jfree.util.Configuration config)
protected boolean	isInputStorageEnabled(org.jfree.util.Configuration config)
protected boolean	performConfirm()
boolean	performQueryForExport(JFreeReport report) Opens the dialog to query all necessary input from the user.
protected abstract boolean	performValidate()
protected void	setCancelAction(javax.swing.Action cancelAction)
protected void	setConfirmAction(javax.swing.Action confirmAction)
protected void	setConfirmed(boolean confirmed) Defines whether this dialog has been finished using the 'OK' or the 'Cancel' option.
protected abstract void	setDialogContents(java.util.Properties properties, boolean full)
protected abstract void	storeToConfiguration(org.jfree.base.config.ModifiableConfiguration reportConfiguration)

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setLocationRelativeTo, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Dialog

addNotify, dispose, getTitle, hide, isModal, isResizable, setModal, setResizable, setTitle, show

Methods inherited from class java.awt.Window

addWindowListener, applyResourceBundle, applyResourceBundle, finalize, getFocusOwner, getInputContext, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFont, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

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(java.awt.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(java.awt.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 Detail

getStatusBar

public JStatusBar getStatusBar()

getCancelAction

protected javax.swing.Action getCancelAction()

setCancelAction

protected void setCancelAction(javax.swing.Action cancelAction)

getConfirmAction

protected javax.swing.Action getConfirmAction()

setConfirmAction

protected void setConfirmAction(javax.swing.Action confirmAction)

performValidate

protected abstract boolean performValidate()

getFormValidator

protected FormValidator getFormValidator()

performQueryForExport

public boolean performQueryForExport(JFreeReport report)

Opens the dialog to query all necessary input from the user. This will not start the processing, as this is done elsewhere.

Parameters:

report - the report that should be processed.

Returns:

true, if the processing should continue, false otherwise.

getConfigurationPrefix

protected abstract java.lang.String getConfigurationPrefix()

getDialogContents

protected abstract java.util.Properties getDialogContents(boolean full)

storeToConfiguration

protected abstract void storeToConfiguration(org.jfree.base.config.ModifiableConfiguration reportConfiguration)

setDialogContents

protected abstract void setDialogContents(java.util.Properties properties,
                                          boolean full)

initFromConfiguration

protected abstract void initFromConfiguration(org.jfree.util.Configuration reportConfiguration)

getConfigurationSuffix

protected abstract java.lang.String getConfigurationSuffix()

getResources

protected java.util.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.jfree.util.Configuration config)

isFullInputStorageEnabled

protected boolean isFullInputStorageEnabled(org.jfree.util.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 java.lang.String getResourceBaseName()