org.pentaho.reporting.engine.classic.core.modules.gui.plaintext

Class PlainTextExportDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.pentaho.reporting.engine.classic.core.modules.gui.base.AbstractExportDialog

org.pentaho.reporting.engine.classic.core.modules.gui.plaintext.PlainTextExportDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, ExportDialog

public class PlainTextExportDialog
extends AbstractExportDialog

A dialog that is used to export reports to plain text.

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.Window

Window.Type

Nested classes/interfaces inherited from class java.awt.Component

Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static Float	CPI_10 10 characters per inch.
static Float	CPI_12 12 characters per inch.
static Float	CPI_15 15 characters per inch.
static Float	CPI_17 17 characters per inch.
static Float	CPI_20 20 characters per inch.
static Float	LPI_10 10 lines per inch.
static Float	LPI_6 6 lines per inch.
static int	TYPE_EPSON24_OUTPUT Epson printer output.
static int	TYPE_EPSON9_OUTPUT Epson printer output.
static int	TYPE_IBM_OUTPUT IBM printer output.
static int	TYPE_PLAIN_OUTPUT Plain text output.

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

Constructors

Constructor and Description
PlainTextExportDialog() Creates a non-modal dialog without a title and without a specified Frame owner.
PlainTextExportDialog(Dialog owner) Creates a non-modal dialog without a title with the specified Dialog as its owner.
PlainTextExportDialog(Frame owner) Creates a non-modal dialog without a title with the specified Frame as its owner.

Method Summary

Modifier and Type	Method and Description
void	clear() clears all selections, input fields and set the selected encryption level to none.
float	getCharsPerInch() Returns the characters-per-inch setting.
String	getEncoding() Returns the encoding.
String	getFilename() Returns the filename.
float	getLinesPerInch() Returns the lines-per-inch setting.
String	getSelected24PinPrinterModel()
String	getSelected9PinPrinterModel() Warning: Might return null!
int	getSelectedPrinter() Returns the selected printer.
JStatusBar	getStatusBar()
boolean	performValidate() Validates the contents of the dialog's input fields.
void	setCharsPerInch(float cpi) Sets the characters per inch.
void	setEncoding(String encoding) Sets the encoding.
void	setFilename(String filename) Defines the filename of the file.
void	setLinesPerInch(float lpi) Sets the lines per inch.
void	setSelected24PinPrinterModel(String selectedPrinterModel)
void	setSelected9PinPrinterModel(String selectedPrinterModel)
void	setSelectedPrinter(int type) Sets the selected printer.

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, 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, 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, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, 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, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_PLAIN_OUTPUT

public static final int TYPE_PLAIN_OUTPUT

Plain text output.

See Also:

Constant Field Values

TYPE_EPSON9_OUTPUT

public static final int TYPE_EPSON9_OUTPUT

Epson printer output.

See Also:

Constant Field Values

TYPE_IBM_OUTPUT

public static final int TYPE_IBM_OUTPUT

IBM printer output.

See Also:

Constant Field Values

TYPE_EPSON24_OUTPUT

public static final int TYPE_EPSON24_OUTPUT

Epson printer output.

See Also:

Constant Field Values

LPI_6

public static final Float LPI_6

6 lines per inch.

LPI_10

public static final Float LPI_10

10 lines per inch.

CPI_10

public static final Float CPI_10

10 characters per inch.

CPI_12

public static final Float CPI_12

12 characters per inch.

CPI_15

public static final Float CPI_15

15 characters per inch.

CPI_17

public static final Float CPI_17

17 characters per inch.

CPI_20

public static final Float CPI_20

20 characters per inch.

Constructor Detail

PlainTextExportDialog

public PlainTextExportDialog()

Creates a non-modal dialog without a title and without a specified Frame owner. A shared, hidden frame will be set as the owner of the Dialog.

PlainTextExportDialog

public PlainTextExportDialog(Frame owner)

Creates a non-modal dialog without a title with the specified Frame as its owner.

Parameters:

owner - the Frame from which the dialog is displayed

PlainTextExportDialog

public PlainTextExportDialog(Dialog owner)

Creates a non-modal dialog without a title with the specified Dialog as its owner.

Parameters:

owner - the Dialog from which the dialog is displayed

Method Detail

getStatusBar

public JStatusBar getStatusBar()

Specified by:

getStatusBar in class AbstractExportDialog

setSelectedPrinter

public void setSelectedPrinter(int type)

Sets the selected printer.

Parameters:

type - the type.

getSelectedPrinter

public int getSelectedPrinter()

Returns the selected printer.

Returns:

The printer type.

getFilename

public String getFilename()

Returns the filename.

Returns:

the name of the file where to save the file.

setFilename

public void setFilename(String filename)

Defines the filename of the file.

Parameters:

filename - the filename of the file

clear

public void clear()

clears all selections, input fields and set the selected encryption level to none.

Specified by:

clear in class AbstractExportDialog

getLinesPerInch

public float getLinesPerInch()

Returns the lines-per-inch setting.

Returns:

The lines-per-inch setting.

setLinesPerInch

public void setLinesPerInch(float lpi)

Sets the lines per inch.

Parameters:

lpi - the lines per inch.

getCharsPerInch

public float getCharsPerInch()

Returns the characters-per-inch setting.

Returns:

The characters-per-inch setting.

setCharsPerInch

public void setCharsPerInch(float cpi)

Sets the characters per inch.

Parameters:

cpi - the characters per inch.

getEncoding

public String getEncoding()

Returns the encoding.

Returns:

The encoding.

setEncoding

public void setEncoding(String encoding)

Sets the encoding.

Parameters:

encoding - the encoding.

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

getSelected9PinPrinterModel

public String getSelected9PinPrinterModel()

Warning: Might return null!

Returns:

getSelected24PinPrinterModel

public String getSelected24PinPrinterModel()

setSelected9PinPrinterModel

public void setSelected9PinPrinterModel(String selectedPrinterModel)

setSelected24PinPrinterModel

public void setSelected24PinPrinterModel(String selectedPrinterModel)