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
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JDialog
JDialog.AccessibleJDialog
Nested classes/interfaces inherited from class java.awt.Dialog
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
Nested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow, Window.Type
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
Fields inherited from class java.awt.Dialog
DEFAULT_MODALITY_TYPE
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a non-modal dialog without a title and without a specifiedFrame
owner.AbstractExportDialog
(Dialog owner) Creates a non-modal dialog without a title with the specifiedDialog
as its owner.AbstractExportDialog
(Frame owner) Creates a non-modal dialog without a title with the specifiedFrame
as its owner. -
Method Summary
Modifier and TypeMethodDescriptionabstract void
clear()
protected Action
protected abstract String
protected abstract String
protected Action
protected FormValidator
protected GuiContext
protected ReportJob
protected abstract String
protected ResourceBundle
Retrieves the resources for this dialog.abstract JStatusBar
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.protected abstract void
initializeFromJob
(ReportJob job, GuiContext guiContext) boolean
Returnstrue
if the user confirmed the selection, andfalse
otherwise.protected boolean
isFullInputStorageEnabled
(org.pentaho.reporting.libraries.base.config.Configuration config) protected boolean
isInputStorageEnabled
(org.pentaho.reporting.libraries.base.config.Configuration config) protected boolean
boolean
performQueryForExport
(ReportJob reportJob, GuiContext guiContext) Opens the dialog to query all necessary input from the user.protected abstract boolean
protected File
resolvePath
(String baseDirectory) Resolves file names for the exports.protected void
setCancelAction
(Action cancelAction) protected void
setConfirmAction
(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
(org.pentaho.reporting.libraries.base.config.Configuration properties) Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
Methods inherited from class java.awt.Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Constructor Details
-
AbstractExportDialog
public AbstractExportDialog()Creates a non-modal dialog without a title and without a specifiedFrame
owner. A shared, hidden frame will be set as the owner of the dialog. -
AbstractExportDialog
Creates a non-modal dialog without a title with the specifiedFrame
as its owner. Ifowner
isnull
, a shared, hidden frame will be set as the owner of the dialog.- Parameters:
owner
- theFrame
from which the dialog is displayed
-
AbstractExportDialog
Creates a non-modal dialog without a title with the specifiedDialog
as its owner.- Parameters:
owner
- the non-nullDialog
from which the dialog is displayed
-
-
Method Details
-
getStatusBar
-
getCancelAction
-
setCancelAction
-
getConfirmAction
-
setConfirmAction
-
performValidate
protected abstract boolean performValidate() -
getFormValidator
-
initializeFromJob
-
getReportJob
-
getGuiContext
-
performQueryForExport
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 interfaceExportDialog
- Parameters:
reportJob
- the report that should be processed.- Returns:
- true, if the processing should continue, false otherwise.
-
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
-
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()Returnstrue
if the user confirmed the selection, andfalse
otherwise. The file should only be saved if the result istrue
.- 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 totrue
, if OK was pressed,false
otherwise
-
performConfirm
protected boolean performConfirm() -
clear
public abstract void clear() -
getResourceBaseName
-
resolvePath
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.
-