org.pentaho.reporting.engine.classic.core.modules.gui.html
Class HtmlDirExportDialog

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.html.HtmlDirExportDialog

All Implemented Interfaces:

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

public class HtmlDirExportDialog
extends AbstractExportDialog

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

Author:

Heiko Evermann

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	HTML_OUTPUT_ENCODING The 'HTML encoding' property key.
static String	HTML_OUTPUT_ENCODING_DEFAULT A default value of the 'HTML 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

HtmlDirExportDialog()
Creates a new HTML save dialog.

HtmlDirExportDialog(Dialog owner)
Creates a new HTML export dialog.

HtmlDirExportDialog(Frame owner)
Creates a new HTML save dialog.

Method Summary

void	clear() Clears all selections and input fields.
String	getAuthor() Gets the author of the dialog.
String	getDataFilename() Returns the directory data file name.
String	getDescription()
String	getEncoding() Returns the selected encoding.
String	getFilename() Returns the directory file name.
String	getHTMLTitle() Returns the title of the HTML file.
String	getKeywords()
JStatusBar	getStatusBar()
boolean	isStrictLayout() Returns the setting of the 'strict layout' check-box.
boolean	performValidate() Validates the contents of the dialog's input fields.
void	setAuthor(String author) Defines the Author of the report.
void	setDataFilename(String dirFilename) Sets the directory data file name.
void	setDescription(String description)
void	setEncoding(String encoding) Sets the encoding.
void	setFilename(String dirFilename) Sets the directory file name.
void	setHTMLTitle(String title) Defines the title of the HTML file.
void	setKeywords(String keywords)
void	setStrictLayout(boolean s) Sets the 'strict layout' check-box.

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

HTML_OUTPUT_ENCODING

public static final String HTML_OUTPUT_ENCODING

The 'HTML encoding' property key.

See Also:

Constant Field Values

HTML_OUTPUT_ENCODING_DEFAULT

public static final String HTML_OUTPUT_ENCODING_DEFAULT

A default value of the 'HTML encoding' property key.

See Also:

Constant Field Values

Constructor Detail

HtmlDirExportDialog

public HtmlDirExportDialog(Frame owner)

Creates a new HTML save dialog.

Parameters:

owner - the dialog owner.

HtmlDirExportDialog

public HtmlDirExportDialog(Dialog owner)

Creates a new HTML export dialog.

Parameters:

owner - the dialog owner.

HtmlDirExportDialog

public HtmlDirExportDialog()

Creates a new HTML save dialog. The created dialog is modal.

Method Detail

getStatusBar

public JStatusBar getStatusBar()

Specified by:

getStatusBar in class AbstractExportDialog

getHTMLTitle

public String getHTMLTitle()

Returns the title of the HTML file.

Returns:

the title

setHTMLTitle

public void setHTMLTitle(String title)

Defines the title of the HTML file.

Parameters:

title - the title

getAuthor

public String getAuthor()

Gets the author of the dialog. This is not yet implemented in the HTML-Target.

Returns:

the name of the author of this report.

setAuthor

public void setAuthor(String author)

Defines the Author of the report. Any freeform text is valid. This defaults to the value of the systemProperty "user.name".

Parameters:

author - the name of the author.

setKeywords

public void setKeywords(String keywords)

getKeywords

public String getKeywords()

setDescription

public void setDescription(String description)

getDescription

public String getDescription()

clear

public void clear()

Clears all selections and input fields.

Specified by:

clear in class AbstractExportDialog

getDataFilename

public String getDataFilename()

Returns the directory data file name.

Returns:

The file name.

setDataFilename

public void setDataFilename(String dirFilename)

Sets the directory data file name.

Parameters:

dirFilename - the file name.

getFilename

public String getFilename()

Returns the directory file name.

Returns:

The directory file name.

setFilename

public void setFilename(String dirFilename)

Sets the directory file name.

Parameters:

dirFilename - the file name.

isStrictLayout

public boolean isStrictLayout()

Returns the setting of the 'strict layout' check-box.

Returns:

A boolean.

setStrictLayout

public void setStrictLayout(boolean s)

Sets the 'strict layout' check-box.

Parameters:

s - boolean.

getEncoding

public String getEncoding()

Returns the selected encoding.

Returns:

The encoding name.

setEncoding

public void setEncoding(String encoding)

Sets the encoding.

Parameters:

encoding - the encoding name.

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