com.compomics.util.gui.waiting.waitinghandlers
Class ProgressDialogX

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 com.compomics.util.gui.waiting.waitinghandlers.ProgressDialogX
All Implemented Interfaces:
WaitingHandler, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class ProgressDialogX
extends JDialog
implements WaitingHandler

A dialog for displaying information about progress.

Author:
Harald Barsnes, Marc Vaudel
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
 
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 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 com.compomics.util.waiting.WaitingHandler
sdf, tab
 
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
ProgressDialogX(boolean modal)
          Opens a new ProgressDialog.
ProgressDialogX(Frame waitingHandlerParent, Image normalIcon, Image waitingIcon, boolean modal)
          Opens a new ProgressDialogX with a Frame as a parent.
ProgressDialogX(JDialog waitingHandlerParent, Frame waitingHandlerParentFrame, Image normalIcon, Image waitingIcon, boolean modal)
          Opens a new ProgressDialog with a JDialog as a parent.
 
Method Summary
 void addWaitingActionListener(WaitingActionListener waitingActionListener)
          Adds a waiting action listener.
 void appendReport(String report, boolean includeDate, boolean addNewLine)
          Append text to the report.
 void appendReportEndLine()
          Append a new line to the report.
 void appendReportNewLineNoDate()
          Append two tabs to the report.
 int getMaxPrimaryProgressCounter()
          Returns the max primary progress counter.
 int getMaxSecondaryProgressCounter()
          Returns the max secondary progress counter.
 int getPrimaryProgressCounter()
          Returns the primary progress counter.
 JProgressBar getProgressBar()
          Returns the progress bar for updates from external processes.
 int getSecondaryProgressCounter()
          Returns the secondary progress counter.
 void increasePrimaryProgressCounter()
          Increase the primary progress counter by one "counter".
 void increasePrimaryProgressCounter(int increment)
          Increase the primary progress counter by the given increment.
 void increaseSecondaryProgressCounter()
          Increases the progress bar.
 void increaseSecondaryProgressCounter(int number)
          Increases the value of the progress bar.
 boolean isReport()
          Indicates whether this waiting handler supports reports.
 boolean isRunCanceled()
          Returns true if the run is canceled.
 boolean isRunFinished()
          Returns true if the process is finished.
 void resetPrimaryProgressCounter()
          Reset the primary progress counter to 0.
 void resetSecondaryProgressCounter()
          Resets the value of the progress bar.
 void setMaxPrimaryProgressCounter(int maxProgressValue)
          Set the maximum value for the primary progress counter.
 void setMaxSecondaryProgressCounter(int maxProgressValue)
          Sets the maximal value of the progress bar.
 void setPrimaryProgressCounterIndeterminate(boolean indeterminate)
          Sets whether the primary progress counter is indeterminate or not.
 void setRunCanceled()
          Set the process as canceled.
 void setRunFinished()
          Set the process as finished.
 void setSecondaryProgressCounter(int value)
          Sets the value of the progress bar.
 void setSecondaryProgressCounterIndeterminate(boolean indeterminate)
          Makes the dialog indeterminate or not indeterminate.
 void setSecondaryProgressText(String text)
          Set the secondary progress counter text.
 void setString(String currentFileName)
          Sets the string to display in the progress bar.
 void setUnstoppable(boolean unstoppable)
          Set this to true of the process the progress bar is used for is not possible to stop, or not possible to stop nicely.
 void setValue(int value)
          Sets the progress bar value.
 void setWaitingText(String text)
          Sets the text describing what is currently being waited for.
 
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, paint, 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, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProgressDialogX

public ProgressDialogX(Frame waitingHandlerParent,
                       Image normalIcon,
                       Image waitingIcon,
                       boolean modal)
Opens a new ProgressDialogX with a Frame as a parent.

Parameters:
waitingHandlerParent -
waitingIcon - the frame icon to use when waiting
normalIcon - the frame icon to use when done
modal -

ProgressDialogX

public ProgressDialogX(JDialog waitingHandlerParent,
                       Frame waitingHandlerParentFrame,
                       Image normalIcon,
                       Image waitingIcon,
                       boolean modal)
Opens a new ProgressDialog with a JDialog as a parent.

Parameters:
waitingHandlerParent -
waitingHandlerParentFrame - the dialog's parent frame (needed to set the frame icons)
waitingIcon - the frame icon to use when waiting
normalIcon - the frame icon to use when done
modal -

ProgressDialogX

public ProgressDialogX(boolean modal)
Opens a new ProgressDialog.

Parameters:
modal -
Method Detail

setValue

public void setValue(int value)
Sets the progress bar value.

Parameters:
value - the progress bar value

setPrimaryProgressCounterIndeterminate

public void setPrimaryProgressCounterIndeterminate(boolean indeterminate)
Description copied from interface: WaitingHandler
Sets whether the primary progress counter is indeterminate or not.

Specified by:
setPrimaryProgressCounterIndeterminate in interface WaitingHandler
Parameters:
indeterminate - a boolean indicating whether the primary progress counter is indeterminate or not

setString

public void setString(String currentFileName)
Sets the string to display in the progress bar. For example to show the name of the file currently being converted.

Parameters:
currentFileName -

setUnstoppable

public void setUnstoppable(boolean unstoppable)
Set this to true of the process the progress bar is used for is not possible to stop, or not possible to stop nicely. If the user still tries to close the progress bar the a warning message is first shown were the user has to confirm that he/she still wants to close the progress bar.

Parameters:
unstoppable -

getProgressBar

public JProgressBar getProgressBar()
Returns the progress bar for updates from external processes.

Returns:
the progress bar

setMaxPrimaryProgressCounter

public void setMaxPrimaryProgressCounter(int maxProgressValue)
Description copied from interface: WaitingHandler
Set the maximum value for the primary progress counter.

Specified by:
setMaxPrimaryProgressCounter in interface WaitingHandler
Parameters:
maxProgressValue - the max value

increasePrimaryProgressCounter

public void increasePrimaryProgressCounter()
Description copied from interface: WaitingHandler
Increase the primary progress counter by one "counter".

Specified by:
increasePrimaryProgressCounter in interface WaitingHandler

increasePrimaryProgressCounter

public void increasePrimaryProgressCounter(int increment)
Description copied from interface: WaitingHandler
Increase the primary progress counter by the given increment.

Specified by:
increasePrimaryProgressCounter in interface WaitingHandler
Parameters:
increment - the increment to increase the value by

setMaxSecondaryProgressCounter

public void setMaxSecondaryProgressCounter(int maxProgressValue)
Sets the maximal value of the progress bar.

Specified by:
setMaxSecondaryProgressCounter in interface WaitingHandler
Parameters:
maxProgressValue - the maximal progress value

resetSecondaryProgressCounter

public void resetSecondaryProgressCounter()
Resets the value of the progress bar.

Specified by:
resetSecondaryProgressCounter in interface WaitingHandler

increaseSecondaryProgressCounter

public void increaseSecondaryProgressCounter()
Increases the progress bar.

Specified by:
increaseSecondaryProgressCounter in interface WaitingHandler

setSecondaryProgressCounter

public void setSecondaryProgressCounter(int value)
Sets the value of the progress bar.

Specified by:
setSecondaryProgressCounter in interface WaitingHandler
Parameters:
value - the progress value

increaseSecondaryProgressCounter

public void increaseSecondaryProgressCounter(int number)
Increases the value of the progress bar.

Specified by:
increaseSecondaryProgressCounter in interface WaitingHandler
Parameters:
number - the increment number

setSecondaryProgressCounterIndeterminate

public void setSecondaryProgressCounterIndeterminate(boolean indeterminate)
Makes the dialog indeterminate or not indeterminate. Also turns the paint progress string on or off.

Specified by:
setSecondaryProgressCounterIndeterminate in interface WaitingHandler
Parameters:
indeterminate -

setRunFinished

public void setRunFinished()
Description copied from interface: WaitingHandler
Set the process as finished.

Specified by:
setRunFinished in interface WaitingHandler

setRunCanceled

public void setRunCanceled()
Description copied from interface: WaitingHandler
Set the process as canceled.

Specified by:
setRunCanceled in interface WaitingHandler

appendReport

public void appendReport(String report,
                         boolean includeDate,
                         boolean addNewLine)
Description copied from interface: WaitingHandler
Append text to the report.

Specified by:
appendReport in interface WaitingHandler
Parameters:
report - the text to append
includeDate - if the date and time is to be added to the front of the text
addNewLine - add a new line after the text?

appendReportNewLineNoDate

public void appendReportNewLineNoDate()
Description copied from interface: WaitingHandler
Append two tabs to the report. No new line.

Specified by:
appendReportNewLineNoDate in interface WaitingHandler

appendReportEndLine

public void appendReportEndLine()
Description copied from interface: WaitingHandler
Append a new line to the report.

Specified by:
appendReportEndLine in interface WaitingHandler

isRunCanceled

public boolean isRunCanceled()
Description copied from interface: WaitingHandler
Returns true if the run is canceled.

Specified by:
isRunCanceled in interface WaitingHandler
Returns:
true if the run is canceled

isRunFinished

public boolean isRunFinished()
Description copied from interface: WaitingHandler
Returns true if the process is finished.

Specified by:
isRunFinished in interface WaitingHandler
Returns:
true if the process is finished

setWaitingText

public void setWaitingText(String text)
Description copied from interface: WaitingHandler
Sets the text describing what is currently being waited for.

Specified by:
setWaitingText in interface WaitingHandler
Parameters:
text - a text describing what is currently waited for

isReport

public boolean isReport()
Description copied from interface: WaitingHandler
Indicates whether this waiting handler supports reports.

Specified by:
isReport in interface WaitingHandler
Returns:
a boolean indicating whether this waiting handler supports reports

addWaitingActionListener

public void addWaitingActionListener(WaitingActionListener waitingActionListener)
Adds a waiting action listener.

Parameters:
waitingActionListener -

setSecondaryProgressText

public void setSecondaryProgressText(String text)
Description copied from interface: WaitingHandler
Set the secondary progress counter text.

Specified by:
setSecondaryProgressText in interface WaitingHandler
Parameters:
text - the text to set

resetPrimaryProgressCounter

public void resetPrimaryProgressCounter()
Description copied from interface: WaitingHandler
Reset the primary progress counter to 0.

Specified by:
resetPrimaryProgressCounter in interface WaitingHandler

getPrimaryProgressCounter

public int getPrimaryProgressCounter()
Description copied from interface: WaitingHandler
Returns the primary progress counter.

Specified by:
getPrimaryProgressCounter in interface WaitingHandler
Returns:
primary progress counter

getMaxPrimaryProgressCounter

public int getMaxPrimaryProgressCounter()
Description copied from interface: WaitingHandler
Returns the max primary progress counter.

Specified by:
getMaxPrimaryProgressCounter in interface WaitingHandler
Returns:
max primary progress counter

getSecondaryProgressCounter

public int getSecondaryProgressCounter()
Description copied from interface: WaitingHandler
Returns the secondary progress counter.

Specified by:
getSecondaryProgressCounter in interface WaitingHandler
Returns:
secondary progress counter

getMaxSecondaryProgressCounter

public int getMaxSecondaryProgressCounter()
Description copied from interface: WaitingHandler
Returns the max secondary progress counter.

Specified by:
getMaxSecondaryProgressCounter in interface WaitingHandler
Returns:
max secondary progress counter


Copyright © 2013. All Rights Reserved.