com.jrefinery.report.preview
Class CSVExportDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      com.jrefinery.report.preview.CSVExportDialog

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class CSVExportDialog

extends javax.swing.JDialog

A dialog for exporting a report to CSV format.

Author:

Thomas Morgner.

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

CSVExportDialog()
Creates a new CSV export dialog.

CSVExportDialog(java.awt.Dialog owner)
Creates a new CSV export dialog.

CSVExportDialog(java.awt.Frame owner)
Creates a new CSV export dialog.

Method Summary

void	clear() Clears all selections, input fields and sets the selected encryption level to none.
java.lang.String	getEncoding() Returns the encoding.
java.lang.String	getFilename() Returns the export file name.
java.lang.String	getSeparatorString() Returns the separator string, which is controlled by the selection of radio buttons.
void	initFromConfiguration(ReportConfiguration config) Initialises the CSV export dialog from the settings in the report configuration.
boolean	isConfirmed() Returns true if the user confirmed the selection, and false otherwise.
boolean	isExportRawData() Returns true if the user selected to export raw data only, and false otherwise.
boolean	isStrictLayout() Returns the current setting of the 'strict layout' combo-box.
static void	main(java.lang.String[] args) This method exists for debugging purposes.
boolean	performExport(JFreeReport report) Shows this dialog and (if the dialog is confirmed) saves the complete report into a CSV 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	setEncoding(java.lang.String encoding) Sets the encoding.
void	setExportRawData(boolean b) Sets a flag that controls whether raw data is exported.
void	setFilename(java.lang.String filename) Sets the export file name.
void	setSeparatorString(java.lang.String s) Sets the separator string.
void	setStrictLayout(boolean strictLayout) Sets the 'strict layout' combo-box setting.
boolean	writeLayoutedCSV(JFreeReport report) Saves a report to CSV format.
boolean	writeRawCSV(JFreeReport report) Saves a report to CSV 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

CSVExportDialog

public CSVExportDialog(java.awt.Frame owner)

Creates a new CSV export dialog.

Parameters:

owner - the dialog owner.

CSVExportDialog

public CSVExportDialog(java.awt.Dialog owner)

Creates a new CSV export dialog.

Parameters:

owner - the dialog owner.

CSVExportDialog

public CSVExportDialog()

Creates a new CSV export dialog. The created dialog is modal.

Method Detail

getFilename

public java.lang.String getFilename()

Returns the export file name.

Returns:

The file name.

setFilename

public void setFilename(java.lang.String filename)

Sets the export file name.

Parameters:

filename - the file name.

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

clear

public void clear()

Clears all selections, input fields and sets the selected encryption level to none.

getSeparatorString

public java.lang.String getSeparatorString()

Returns the separator string, which is controlled by the selection of radio buttons.

Returns:

The separator string.

setSeparatorString

public void setSeparatorString(java.lang.String s)

Sets the separator string.

Parameters:

s - the separator.

getEncoding

public java.lang.String getEncoding()

Returns the encoding.

Returns:

The encoding.

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the encoding.

Parameters:

encoding - the encoding.

isExportRawData

public boolean isExportRawData()

Returns true if the user selected to export raw data only, and false otherwise.

Returns:

A boolean.

setExportRawData

public void setExportRawData(boolean b)

Sets a flag that controls whether raw data is exported.

Parameters:

b - the new flag value.

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 a CSV file.

Parameters:

report - the report being processed.

Returns:

true or false.

writeLayoutedCSV

public boolean writeLayoutedCSV(JFreeReport report)

Saves a report to CSV format.

Parameters:

report - the report.

Returns:

true or false.

writeRawCSV

public boolean writeRawCSV(JFreeReport report)

Saves a report to CSV format.

Parameters:

report - the report.

Returns:

true or false.

initFromConfiguration

public void initFromConfiguration(ReportConfiguration config)

Initialises the CSV export dialog from the settings in the report configuration.

Parameters:

config - the report configuration.

isStrictLayout

public boolean isStrictLayout()

Returns the current setting of the 'strict layout' combo-box.

Returns:

A boolean.

setStrictLayout

public void setStrictLayout(boolean strictLayout)

Sets the 'strict layout' combo-box setting.

Parameters:

strictLayout - the new setting.

main

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

This method exists for debugging purposes.

Parameters:

args - ignored.