com.jrefinery.report.preview
Class ExcelExportDialog

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Dialog
                  extended byjavax.swing.JDialog
                      extended bycom.jrefinery.report.preview.ExcelExportDialog
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class ExcelExportDialog
extends javax.swing.JDialog

A dialog that is used to perform the printing of a report into an Excel file.

The main method to call the dialog is performExport(com.jrefinery.report.JFreeReport). Given a report and a pageformat, the dialog is shown and if the user approved the dialog, the excel file is saved using the settings made in the dialog.

Author:
Heiko Evermann
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog
 
Nested classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static java.lang.String BASE_RESOURCE_CLASS
          The base resource class.
 
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
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
ExcelExportDialog()
          Creates a new Excel save dialog.
ExcelExportDialog(java.awt.Dialog owner)
          Creates a new Excel dialog.
ExcelExportDialog(java.awt.Frame owner)
          Creates a new Excel save dialog.
 
Method Summary
 void clear()
          Clears all selections and input fields.
 java.lang.String getFilename()
          Returns the filename of the excel file.
 java.util.ResourceBundle getResources()
          Returns the resource bundle used for that dialog.
 void initFromConfiguration(ReportConfiguration config)
          Initialises the Excel export dialog from the settings in the report configuration.
 boolean isConfirmed()
          Gets the confirmation state of the dialog.
 boolean isStrictLayout()
          Returns the setting of the 'strict layout' check-box.
static void main(java.lang.String[] args)
          For debugging.
 boolean performExport(JFreeReport report)
          Shows this dialog and (if the dialog is confirmed) saves the complete report into an Excel file.
protected  void performSelectFile()
          Selects a file to use as target for the report processing.
 boolean performValidate()
          Validates the contents of the dialog's input fields.
protected  void setConfirmed(boolean confirmed)
          Defines whether this dialog has been finished using the 'OK' or the 'Cancel' option.
 void setFilename(java.lang.String filename)
          Defines the filename of the excel file.
 void setStrictLayout(boolean strictLayout)
          Sets the 'strict-layout' check-box.
 boolean writeExcel(JFreeReport report)
          Saves a report to Excel format.
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

BASE_RESOURCE_CLASS

public static final java.lang.String BASE_RESOURCE_CLASS
The base resource class.

See Also:
Constant Field Values
Constructor Detail

ExcelExportDialog

public ExcelExportDialog(java.awt.Frame owner)
Creates a new Excel save dialog.

Parameters:
owner - the dialog owner.

ExcelExportDialog

public ExcelExportDialog(java.awt.Dialog owner)
Creates a new Excel dialog.

Parameters:
owner - the dialog owner.

ExcelExportDialog

public ExcelExportDialog()
Creates a new Excel save dialog. The created dialog is modal.

Method Detail

getResources

public java.util.ResourceBundle getResources()
Returns the resource bundle used for that dialog.

Returns:
the resource bundle

getFilename

public java.lang.String getFilename()
Returns the filename of the excel file.

Returns:
the name of the file where to save the excel file.

setFilename

public void setFilename(java.lang.String filename)
Defines the filename of the excel file.

Parameters:
filename - the filename of the excel file

isConfirmed

public boolean isConfirmed()
Gets the confirmation state of the dialog. A confirmed dialog has no invalid settings and the user confirmed any resource conflicts.

Returns:
true, if the dialog has been confirmed and the excel file should be saved, false otherwise.

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

isStrictLayout

public boolean isStrictLayout()
Returns the setting of the 'strict layout' check-box.

Returns:
A boolean.

setStrictLayout

public void setStrictLayout(boolean strictLayout)
Sets the 'strict-layout' check-box.

Parameters:
strictLayout - the new setting.

clear

public void clear()
Clears all selections and input fields.


performSelectFile

protected void performSelectFile()
Selects a file to use as target for the report processing.


performValidate

public boolean performValidate()
Validates the contents of the dialog's input fields. If the selected file exists, it is also checked for validity.

Returns:
true, if the input is valid, false otherwise

performExport

public boolean performExport(JFreeReport report)
Shows this dialog and (if the dialog is confirmed) saves the complete report into an Excel file.

Parameters:
report - the report being processed.
Returns:
true or false.

writeExcel

public boolean writeExcel(JFreeReport report)
Saves a report to Excel format.

Parameters:
report - the report.
Returns:
true or false.

initFromConfiguration

public void initFromConfiguration(ReportConfiguration config)
Initialises the Excel export dialog from the settings in the report configuration.

Parameters:
config - the report configuration.

main

public static void main(java.lang.String[] args)
For debugging.

Parameters:
args - ignored.