org.jfree.report.modules.gui.swing.common
Class ReportProgressDialog

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by org.jfree.report.modules.gui.swing.common.ReportProgressDialog
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ReportProgressDialog
extends javax.swing.JDialog

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 javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes/interfaces inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
 
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
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 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(java.awt.Dialog dialog)
          Creates a non-modal dialog without a title and with the specified Dialog owner.
ReportProgressDialog(java.awt.Frame frame)
          Creates a non-modal dialog without a title and with the specified Frame owner.
 
Method Summary
 java.lang.String getLayoutText()
          Returns the layout text.
 java.lang.String getMessage()
          Returns the current message.
 java.lang.String getOutputText()
          Returns the output text message.
protected  javax.swing.JLabel getPageCountMessage()
          Returns the current pagecount message component.
protected  java.text.MessageFormat getPageMessageFormatter()
          Returns the current pass message component.
protected  javax.swing.JLabel getPassCountMessage()
          Returns the current pass message component.
protected  java.text.MessageFormat getPassMessageFormatter()
          Returns the current pass message component.
protected  javax.swing.JLabel getRowCountMessage()
          Returns the current row message component.
protected  java.text.MessageFormat getRowsMessageFormatter()
          Returns the current pass message component.
protected  boolean isSameMaxRow(int row)
           
 void setLayoutText(java.lang.String layoutText)
          Defines the layout text message.
 void setMessage(java.lang.String message)
          Defines the current message.
 void setOutputText(java.lang.String outputText)
          Defines the output text message.
protected  void updatePageMessage(int page)
          Updates the page message label if the current page has changed.
protected  void updatePassMessage(int pass, boolean prepare)
          Updates the pass message label if either the pass or prepare state changed.
protected  void updateRowsMessage(int rows, int maxRows)
          Updates the rows message label if either the rows or maxrows changed.
 
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, 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, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, 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, paint, 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, 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, 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, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ReportProgressDialog

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

getMessage

public java.lang.String getMessage()
Returns the current message.

Returns:
the current global message.

setMessage

public void setMessage(java.lang.String message)
Defines the current message.

Parameters:
message - the current global message.

updatePageMessage

protected void updatePageMessage(int page)
Updates the page message label if the current page has changed.

Parameters:
page - the new page parameter.

updateRowsMessage

protected void updateRowsMessage(int rows,
                                 int maxRows)
Updates the rows message label if either the rows or maxrows changed.

Parameters:
rows - the currently processed rows.
maxRows - the maximum number of rows in the report.

updatePassMessage

protected void updatePassMessage(int pass,
                                 boolean prepare)
Updates the pass message label if either the pass or prepare state changed. The pass reflects the current processing level, one level for every function dependency level.

Parameters:
pass - the current reporting pass.
prepare - true, if the current run is a prepare run, false otherwise.

getPassCountMessage

protected final javax.swing.JLabel getPassCountMessage()
Returns the current pass message component.

Returns:
the pass message component.

getPageCountMessage

protected final javax.swing.JLabel getPageCountMessage()
Returns the current pagecount message component.

Returns:
the page message component.

getRowCountMessage

protected final javax.swing.JLabel getRowCountMessage()
Returns the current row message component.

Returns:
the row message component.

getPageMessageFormatter

protected final java.text.MessageFormat getPageMessageFormatter()
Returns the current pass message component.

Returns:
the pass message component.

getRowsMessageFormatter

protected final java.text.MessageFormat getRowsMessageFormatter()
Returns the current pass message component.

Returns:
the pass message component.

getPassMessageFormatter

protected final java.text.MessageFormat getPassMessageFormatter()
Returns the current pass message component.

Returns:
the pass message component.

getOutputText

public java.lang.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(java.lang.String outputText)
Defines the output text message. This text describes the export phases of the report processing.

Parameters:
outputText - the output message.

getLayoutText

public java.lang.String getLayoutText()
Returns the layout text. This text describes the prepare phases of the report processing.

Returns:
the layout text.

setLayoutText

public void setLayoutText(java.lang.String layoutText)
Defines the layout text message. This text describes the prepare phases of the report processing.

Parameters:
layoutText - the layout message.

isSameMaxRow

protected boolean isSameMaxRow(int row)