org.pentaho.reporting.engine.classic.core.modules.gui.csv
Class CSVDataExportDialog

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by org.pentaho.reporting.engine.classic.core.modules.gui.base.AbstractExportDialog
                          extended by org.pentaho.reporting.engine.classic.core.modules.gui.csv.CSVDataExportDialog
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, ExportDialog

public class CSVDataExportDialog
extends AbstractExportDialog

A dialog for exporting a report to CSV format.

Author:
Thomas Morgner.
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class java.awt.Dialog
Dialog.ModalExclusionType, Dialog.ModalityType
 
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
 
Field Summary
static String CSV_OUTPUT_ENCODING_DEFAULT
          A default value of the 'CSV encoding' property key.
 
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 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
CSVDataExportDialog()
          Creates a new CSV export dialog.
CSVDataExportDialog(Dialog owner)
          Creates a new CSV export dialog.
CSVDataExportDialog(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.
 String getEncoding()
          Returns the encoding.
 String getFilename()
          Returns the export file name.
 String getSeparatorString()
          Returns the separator string, which is controlled by the selection of radio buttons.
 JStatusBar getStatusBar()
           
 boolean isColumnNamesAsFirstRow()
           
 boolean isEnableGroupFooter()
           
 boolean isEnableGroupHeader()
           
 boolean isEnableItembands()
           
 boolean isEnableReportFooter()
           
 boolean isEnableReportHeader()
           
 boolean isWriteStateColumns()
           
 void setColumnNamesAsFirstRow(boolean colsAsFirstRow)
           
 void setEnableGroupFooter(boolean enableGroupFooter)
           
 void setEnableGroupHeader(boolean enableGroupHeader)
           
 void setEnableItembands(boolean enableItembands)
           
 void setEnableReportFooter(boolean enableReportFooter)
           
 void setEnableReportHeader(boolean enableReportHeader)
           
 void setEncoding(String encoding)
          Sets the encoding.
 void setFilename(String filename)
          Sets the export file name.
 void setSeparatorString(String s)
          Sets the separator string.
 void setWriteStateColumns(boolean writeStateColumns)
           
 
Methods inherited from class org.pentaho.reporting.engine.classic.core.modules.gui.base.AbstractExportDialog
isConfirmed, performQueryForExport
 
Methods inherited from class javax.swing.JDialog
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update
 
Methods inherited from class java.awt.Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CSV_OUTPUT_ENCODING_DEFAULT

public static final String CSV_OUTPUT_ENCODING_DEFAULT
A default value of the 'CSV encoding' property key.

Constructor Detail

CSVDataExportDialog

public CSVDataExportDialog(Frame owner)
Creates a new CSV export dialog.

Parameters:
owner - the dialog owner.

CSVDataExportDialog

public CSVDataExportDialog(Dialog owner)
Creates a new CSV export dialog.

Parameters:
owner - the dialog owner.

CSVDataExportDialog

public CSVDataExportDialog()
Creates a new CSV export dialog. The created dialog is modal.

Method Detail

getStatusBar

public JStatusBar getStatusBar()
Specified by:
getStatusBar in class AbstractExportDialog

getFilename

public String getFilename()
Returns the export file name.

Returns:
The file name.

setFilename

public void setFilename(String filename)
Sets the export file name.

Parameters:
filename - the file name.

clear

public void clear()
Clears all selections, input fields and sets the selected encryption level to none.

Specified by:
clear in class AbstractExportDialog

getSeparatorString

public String getSeparatorString()
Returns the separator string, which is controlled by the selection of radio buttons.

Returns:
The separator string.

setSeparatorString

public void setSeparatorString(String s)
Sets the separator string.

Parameters:
s - the separator.

getEncoding

public String getEncoding()
Returns the encoding.

Returns:
The encoding.

setEncoding

public void setEncoding(String encoding)
Sets the encoding.

Parameters:
encoding - the encoding.

isColumnNamesAsFirstRow

public boolean isColumnNamesAsFirstRow()

setColumnNamesAsFirstRow

public void setColumnNamesAsFirstRow(boolean colsAsFirstRow)

isWriteStateColumns

public boolean isWriteStateColumns()

setWriteStateColumns

public void setWriteStateColumns(boolean writeStateColumns)

isEnableGroupFooter

public boolean isEnableGroupFooter()

setEnableGroupFooter

public void setEnableGroupFooter(boolean enableGroupFooter)

isEnableGroupHeader

public boolean isEnableGroupHeader()

setEnableGroupHeader

public void setEnableGroupHeader(boolean enableGroupHeader)

isEnableItembands

public boolean isEnableItembands()

setEnableItembands

public void setEnableItembands(boolean enableItembands)

isEnableReportFooter

public boolean isEnableReportFooter()

setEnableReportFooter

public void setEnableReportFooter(boolean enableReportFooter)

isEnableReportHeader

public boolean isEnableReportHeader()

setEnableReportHeader

public void setEnableReportHeader(boolean enableReportHeader)