org.pentaho.reporting.engine.classic.core.modules.gui.commonswing
Class ReportProgressDialog

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.commonswing.ReportProgressDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, ReportProgressListener

public class ReportProgressDialog
extends JDialog
implements ReportProgressListener

A progress monitor dialog component that visualizes the report processing progress. It will receive update events from the report processors and updates the UI according to the latest event data.

The progress will be computed according to the currently processed table row. This approach provides relativly accurate data, but assumes that processing all bands consumes roughly the same time.

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

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

ReportProgressDialog()
Creates a non-modal dialog without a title and without a specified Frame owner.

ReportProgressDialog(Dialog dialog)
Creates a non-modal dialog without a title and with the specified Dialog owner.

ReportProgressDialog(Frame frame)
Creates a non-modal dialog without a title and with the specified Frame owner.

Method Summary

String	getLayoutText() Returns the layout text.
String	getMessage() Returns the current message.
String	getOutputText() Returns the output text message.
boolean	isOnlyPagination()
void	reportProcessingFinished(ReportProgressEvent event) Receives a notification that the report processing was finished.
void	reportProcessingStarted(ReportProgressEvent event) Receives a notification that the report processing has started.
void	reportProcessingUpdate(ReportProgressEvent event) Receives a notification that the report processing made some progress.
void	setLayoutText(String layoutText) Defines the layout text message.
void	setMessage(String message) Defines the current message.
void	setOnlyPagination(boolean onlyPagination)
void	setOutputText(String outputText) Defines the output text message.
void	setVisibleInEDT(boolean b)

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

Constructor Detail

ReportProgressDialog

public ReportProgressDialog(Dialog dialog)

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

Parameters:

dialog - the owner of the dialog

ReportProgressDialog

public ReportProgressDialog(Frame frame)

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

Parameters:

frame - the owner of the dialog

ReportProgressDialog

public ReportProgressDialog()

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.

Method Detail

isOnlyPagination

public boolean isOnlyPagination()

setOnlyPagination

public void setOnlyPagination(boolean onlyPagination)

getMessage

public String getMessage()

Returns the current message.

Returns:

the current global message.

setMessage

public void setMessage(String message)

Defines the current message.

Parameters:

message - the current global message.

getOutputText

public String getOutputText()

Returns the output text message. This text describes the export phases of the report processing.

Returns:

the output phase description.

setOutputText

public void setOutputText(String outputText)

Defines the output text message. This text describes the export phases of the report processing.

Parameters:

outputText - the output message.

getLayoutText

public String getLayoutText()

Returns the layout text. This text describes the prepare phases of the report processing.

Returns:

the layout text.

setLayoutText

public void setLayoutText(String layoutText)

Defines the layout text message. This text describes the prepare phases of the report processing.

Parameters:

layoutText - the layout message.

reportProcessingStarted

public void reportProcessingStarted(ReportProgressEvent event)

Description copied from interface: ReportProgressListener

Receives a notification that the report processing has started.

Specified by:

reportProcessingStarted in interface ReportProgressListener

Parameters:

event - the start event.

reportProcessingUpdate

public void reportProcessingUpdate(ReportProgressEvent event)

Description copied from interface: ReportProgressListener

Receives a notification that the report processing made some progress.

Specified by:

reportProcessingUpdate in interface ReportProgressListener

Parameters:

event - the update event.

reportProcessingFinished

public void reportProcessingFinished(ReportProgressEvent event)

Description copied from interface: ReportProgressListener

Receives a notification that the report processing was finished.

Specified by:

reportProcessingFinished in interface ReportProgressListener

Parameters:

event - the finish event.

setVisibleInEDT

public void setVisibleInEDT(boolean b)