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 javax.swing.JDialog
JDialog.AccessibleJDialog
-
Nested classes/interfaces inherited from class java.awt.Dialog
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
-
Nested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow, Window.Type
-
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
-
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
-
Field Summary
Fields Modifier and Type Field Description 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 javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
-
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 java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
-
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
-
-
Constructor Summary
Constructors Constructor Description 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Clears all selections and input fields.String
getAuthor()
Gets the author of the dialog.protected String
getConfigurationPrefix()
protected String
getConfigurationSuffix()
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()
protected String
getResourceBaseName()
JStatusBar
getStatusBar()
protected org.pentaho.reporting.libraries.base.config.Configuration
grabDialogContents(boolean full)
Returns a new (and not connected to the default config from the job) configuration containing all properties from the dialog.boolean
isStrictLayout()
Returns the setting of the 'strict layout' check-box.protected boolean
performConfirm()
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.void
setAuthor(String author)
Defines the Author of the report.void
setDataFilename(String dirFilename)
Sets the directory data file name.void
setDescription(String description)
protected void
setDialogContents(org.pentaho.reporting.libraries.base.config.Configuration p)
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
createButtonPanel, createContentPane, getCancelAction, getConfirmAction, getFormValidator, getGuiContext, getParametersPanel, getReportJob, getResources, initializeFromJob, isConfirmed, isFullInputStorageEnabled, isInputStorageEnabled, performQueryForExport, resolvePath, setCancelAction, setConfirmAction, setConfirmed
-
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, 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, processEvent, processWindowFocusEvent, processWindowStateEvent, 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, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, 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, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
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 classAbstractExportDialog
-
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 classAbstractExportDialog
-
grabDialogContents
protected org.pentaho.reporting.libraries.base.config.Configuration grabDialogContents(boolean full)
Returns a new (and not connected to the default config from the job) configuration containing all properties from the dialog.- Specified by:
grabDialogContents
in classAbstractExportDialog
- Parameters:
full
-- Returns:
-
setDialogContents
protected void setDialogContents(org.pentaho.reporting.libraries.base.config.Configuration p)
- Specified by:
setDialogContents
in classAbstractExportDialog
-
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.
-
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.- Specified by:
performValidate
in classAbstractExportDialog
- Returns:
- true, if the input is valid, false otherwise
-
performConfirm
protected boolean performConfirm()
- Overrides:
performConfirm
in classAbstractExportDialog
-
getConfigurationSuffix
protected String getConfigurationSuffix()
- Specified by:
getConfigurationSuffix
in classAbstractExportDialog
-
getResourceBaseName
protected String getResourceBaseName()
- Specified by:
getResourceBaseName
in classAbstractExportDialog
-
getConfigurationPrefix
protected String getConfigurationPrefix()
- Specified by:
getConfigurationPrefix
in classAbstractExportDialog
-
-