com.jrefinery.report.preview
Class HtmlExportDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--com.jrefinery.report.preview.HtmlExportDialog
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class HtmlExportDialog
extends javax.swing.JDialog

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

Author:
Heiko Evermann
See Also:
Serialized Form

Field Summary
static java.lang.String BASE_RESOURCE_CLASS
          The base resource class.
static int EXPORT_DIR
          Export to a directory.
static int EXPORT_STREAM
          Export to a single stream or file.
static int EXPORT_ZIP
          Export to a ZIP file.
 
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
HtmlExportDialog()
          Creates a new HTML save dialog.
HtmlExportDialog(java.awt.Dialog owner)
          Creates a new HTML export dialog.
HtmlExportDialog(java.awt.Frame owner)
          Creates a new HTML save dialog.
 
Method Summary
 void clear()
          Clears all selections and input fields.
 java.lang.String getAuthor()
          Gets the author of the dialog.
 java.lang.String getDirDataFilename()
          Returns the directory data file name.
 java.lang.String getDirFilename()
          Returns the directory file name.
 java.lang.String getEncoding()
          Returns the selected encoding.
 java.lang.String getHTMLTitle()
          Returns the title of the HTML file.
 int getSelectedExportMethod()
          Returns the selected export method.
 java.lang.String getStreamFilename()
          Returns the stream file name.
 java.lang.String getZipDataFilename()
          Returns the zip data file name.
 java.lang.String getZipFilename()
          Returns the zip file name.
 void initFromConfiguration(ReportConfiguration config)
          Initialises the Html export dialog from the settings in the report configuration.
 boolean isConfirmed()
          Gets the confirmation state of the dialog.
 boolean isGenerateXHTML()
          Returns true if XHTML is selected, false if HTML4.
 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 HTML file.
protected  void performSelectFileDir()
          Selects a file to use as target for the report processing.
protected  void performSelectFileStream()
          Selects a file to use as target for the report processing.
protected  void performSelectFileZip()
          Selects a file to use as target for the report processing.
 boolean performValidateDir()
          Validates the contents of the dialogs input fields.
 boolean performValidateStream()
          Validates the contents of the dialog's input fields.
 boolean performValidateZip()
          Validates the contents of the dialog's input fields.
 void setAuthor(java.lang.String author)
          Defines the Author of the report.
protected  void setConfirmed(boolean confirmed)
          Defines whether this dialog has been finished using the 'OK' or the 'Cancel' option.
 void setDirDataFilename(java.lang.String dirFilename)
          Sets the directory data file name.
 void setDirFilename(java.lang.String dirFilename)
          Sets the directory file name.
 void setEncoding(java.lang.String encoding)
          Sets the encoding.
 void setGenerateXHTML(boolean generateXHTML)
          Sets the radio buttons for XHTML or HTML4 generation.
 void setHTMLTitle(java.lang.String title)
          Defines the title of the HTML file.
 void setSelectedExportMethod(int index)
          Sets the export method.
 void setStreamFilename(java.lang.String streamFilename)
          Sets the stream file name.
 void setStrictLayout(boolean s)
          Sets the 'strict layout' check-box.
 void setZipDataFilename(java.lang.String zipFilename)
          Sets the zip data file name.
 void setZipFilename(java.lang.String zipFilename)
          Sets the zip file name.
 boolean writeHtmlDir(JFreeReport report)
          Writes the report to HTML in a directory.
 boolean writeHtmlStream(JFreeReport report)
          Writes an HTML stream.
 boolean writeHtmlZip(JFreeReport report)
          Writers the report to HTML inside a ZIP file.
 
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

EXPORT_STREAM

public static final int EXPORT_STREAM
Export to a single stream or file.

See Also:
Constant Field Values

EXPORT_DIR

public static final int EXPORT_DIR
Export to a directory.

See Also:
Constant Field Values

EXPORT_ZIP

public static final int EXPORT_ZIP
Export to a ZIP file.

See Also:
Constant Field Values

BASE_RESOURCE_CLASS

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

See Also:
Constant Field Values
Constructor Detail

HtmlExportDialog

public HtmlExportDialog(java.awt.Frame owner)
Creates a new HTML save dialog.

Parameters:
owner - the dialog owner.

HtmlExportDialog

public HtmlExportDialog(java.awt.Dialog owner)
Creates a new HTML export dialog.

Parameters:
owner - the dialog owner.

HtmlExportDialog

public HtmlExportDialog()
Creates a new HTML save dialog. The created dialog is modal.

Method Detail

getHTMLTitle

public java.lang.String getHTMLTitle()
Returns the title of the HTML file.

Returns:
the title

setHTMLTitle

public void setHTMLTitle(java.lang.String title)
Defines the title of the HTML file.

Parameters:
title - the title

getAuthor

public java.lang.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(java.lang.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.

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 HTML 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

clear

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


getDirDataFilename

public java.lang.String getDirDataFilename()
Returns the directory data file name.

Returns:
The file name.

setDirDataFilename

public void setDirDataFilename(java.lang.String dirFilename)
Sets the directory data file name.

Parameters:
dirFilename - the file name.

getDirFilename

public java.lang.String getDirFilename()
Returns the directory file name.

Returns:
The directory file name.

setDirFilename

public void setDirFilename(java.lang.String dirFilename)
Sets the directory file name.

Parameters:
dirFilename - the file name.

getZipFilename

public java.lang.String getZipFilename()
Returns the zip file name.

Returns:
The file name.

setZipFilename

public void setZipFilename(java.lang.String zipFilename)
Sets the zip file name.

Parameters:
zipFilename - the zip file name.

getZipDataFilename

public java.lang.String getZipDataFilename()
Returns the zip data file name.

Returns:
The zip data file name.

setZipDataFilename

public void setZipDataFilename(java.lang.String zipFilename)
Sets the zip data file name.

Parameters:
zipFilename - the file name.

getStreamFilename

public java.lang.String getStreamFilename()
Returns the stream file name.

Returns:
The file name.

setStreamFilename

public void setStreamFilename(java.lang.String streamFilename)
Sets the stream file name.

Parameters:
streamFilename - the file name.

setGenerateXHTML

public void setGenerateXHTML(boolean generateXHTML)
Sets the radio buttons for XHTML or HTML4 generation.

Parameters:
generateXHTML - boolean.

isGenerateXHTML

public boolean isGenerateXHTML()
Returns true if XHTML is selected, false if HTML4.

Returns:
A boolean.

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 java.lang.String getEncoding()
Returns the selected encoding.

Returns:
The encoding name.

setEncoding

public void setEncoding(java.lang.String encoding)
Sets the encoding.

Parameters:
encoding - the encoding name.

performSelectFileStream

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


performSelectFileZip

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


performSelectFileDir

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


performValidateStream

public boolean performValidateStream()
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

performValidateZip

public boolean performValidateZip()
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 HTML file.

Parameters:
report - the report being processed.
Returns:
A boolean.

getSelectedExportMethod

public int getSelectedExportMethod()
Returns the selected export method.

Returns:
the selected Export method, one of EXPORT_STREAM, EXPORT_ZIP or EXPORT_DIR.

setSelectedExportMethod

public void setSelectedExportMethod(int index)
Sets the export method.

Parameters:
index - the method index.

performValidateDir

public boolean performValidateDir()
Validates the contents of the dialogs input fields. If the selected file exists, it is also checked for validity.

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

writeHtmlStream

public boolean writeHtmlStream(JFreeReport report)
Writes an HTML stream.

Parameters:
report - the report.
Returns:
A boolean.

writeHtmlZip

public boolean writeHtmlZip(JFreeReport report)
Writers the report to HTML inside a ZIP file.

Parameters:
report - the report.
Returns:
A boolean.

writeHtmlDir

public boolean writeHtmlDir(JFreeReport report)
Writes the report to HTML in a directory.

Parameters:
report - the report.
Returns:
A boolean.

initFromConfiguration

public void initFromConfiguration(ReportConfiguration config)
Initialises the Html 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.