public abstract class AbstractExportDialog extends javax.swing.JDialog implements ExportDialog
javax.swing.JDialog.AccessibleJDialog
java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type
accessibleContext, rootPane, rootPaneCheckingEnabled
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Constructor and Description |
---|
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. |
Modifier and Type | Method and Description |
---|---|
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 FormValidator |
getFormValidator() |
protected GuiContext |
getGuiContext() |
protected ReportJob |
getReportJob() |
protected abstract java.lang.String |
getResourceBaseName() |
protected java.util.ResourceBundle |
getResources()
Retrieves the resources for this dialog.
|
abstract JStatusBar |
getStatusBar() |
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 |
isConfirmed()
Returns
true if the user confirmed the selection, and
false 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 |
performConfirm() |
boolean |
performQueryForExport(ReportJob reportJob,
GuiContext guiContext)
Opens the dialog to query all necessary input from the user.
|
protected abstract boolean |
performValidate() |
protected java.io.File |
resolvePath(java.lang.String baseDirectory)
Resolves file names for the exports.
|
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(org.pentaho.reporting.libraries.base.config.Configuration properties) |
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
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack
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
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
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, getCaretforIME, 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, getPeer, 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, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
public AbstractExportDialog()
Frame
owner. A shared, hidden frame will be set as the owner
of the dialog.public AbstractExportDialog(java.awt.Frame owner)
Frame
as its owner. If owner
is
null
, a shared, hidden frame will be set as the owner of the
dialog.owner
- the Frame
from which the dialog is displayedpublic AbstractExportDialog(java.awt.Dialog owner)
Dialog
as its owner.owner
- the non-null Dialog
from which the dialog is
displayedpublic abstract JStatusBar getStatusBar()
protected javax.swing.Action getCancelAction()
protected void setCancelAction(javax.swing.Action cancelAction)
protected javax.swing.Action getConfirmAction()
protected void setConfirmAction(javax.swing.Action confirmAction)
protected abstract boolean performValidate()
protected FormValidator getFormValidator()
protected abstract void initializeFromJob(ReportJob job, GuiContext guiContext)
protected ReportJob getReportJob()
protected GuiContext getGuiContext()
public boolean performQueryForExport(ReportJob reportJob, GuiContext guiContext)
performQueryForExport
in interface ExportDialog
reportJob
- the report that should be processed.protected abstract java.lang.String getConfigurationPrefix()
protected abstract org.pentaho.reporting.libraries.base.config.Configuration grabDialogContents(boolean full)
full
- protected abstract void setDialogContents(org.pentaho.reporting.libraries.base.config.Configuration properties)
protected abstract java.lang.String getConfigurationSuffix()
protected java.util.ResourceBundle getResources()
protected boolean isInputStorageEnabled(org.pentaho.reporting.libraries.base.config.Configuration config)
protected boolean isFullInputStorageEnabled(org.pentaho.reporting.libraries.base.config.Configuration config)
public boolean isConfirmed()
true
if the user confirmed the selection, and
false
otherwise. The file should only be saved if the result
is true
.protected void setConfirmed(boolean confirmed)
confirmed
- set to true
, if OK was pressed,
false
otherwiseprotected boolean performConfirm()
public abstract void clear()
protected abstract java.lang.String getResourceBaseName()
protected java.io.File resolvePath(java.lang.String baseDirectory)
baseDirectory
- the base directory as specified in the configuration.java.lang.IllegalArgumentException
- if the base directory is null.