edu.stanford.smi.protegex.owl.ui
Class ProgressDisplayDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      edu.stanford.smi.protegex.owl.ui.ProgressDisplayDialog

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, RootPaneContainer, Serializable, TaskProgressDisplay, WindowConstants

public class ProgressDisplayDialog

extends JDialog

implements TaskProgressDisplay

User: matthewhorridge
The University Of Manchester
Medical Informatics Group
Date: Sep 12, 2005

matthew.horridge@cs.man.ac.uk
www.cs.man.ac.uk/~horridgm

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

private Action	cancelAction
private Task	currentTask
private static int	DISPLAY_DELAY
private JTextArea	primaryMessage
private JProgressBar	progressBar
private JTextArea	secondaryMessage

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

Fields inherited from class java.awt.Window

Fields inherited from class java.awt.Container

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

ProgressDisplayDialog(Frame owner)

Method Summary

void	begin(Task task) Starts the display of progress to the user.
private void	createUI(Frame owner)
void	end() Stops (hides) the progress display.
long	getDisplayDelay() Gets the length of time between the task starting and the progress display being displayed.
boolean	isModal() Determines whether or not the progress display is modal and therfore blocks the main event pump when run() is called.
void	setMessage(String message) Sets the message that will be displayed to the user.
void	setProgress(int progress) Updates the value of the progress that is displayed to the user.
void	setProgressIndeterminate(boolean b) Sets the progress display to indicate that the progress cannot be determined, but the task is proceding as normal.
void	setSubTaskMessage(String message)

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

progressBar

private JProgressBar progressBar

cancelAction

private Action cancelAction

currentTask

private Task currentTask

DISPLAY_DELAY

private static final int DISPLAY_DELAY

See Also:

Constant Field Values

primaryMessage

private JTextArea primaryMessage

secondaryMessage

private JTextArea secondaryMessage

Constructor Detail

ProgressDisplayDialog

public ProgressDisplayDialog(Frame owner)

Method Detail

createUI

private void createUI(Frame owner)

begin

public void begin(Task task)

Description copied from interface: TaskProgressDisplay

Starts the display of progress to the user. Note that this method will be called after any period of delay that is specified by the getDisplayDelay method.

Specified by:

begin in interface TaskProgressDisplay

Parameters:

task - The Task whose progress will be monitored and displayed.

setProgress

public void setProgress(int progress)

Description copied from interface: TaskProgressDisplay

Updates the value of the progress that is displayed to the user.

Specified by:

setProgress in interface TaskProgressDisplay

Parameters:

progress - The progress that will be between the min and max progress for the Task

setProgressIndeterminate

public void setProgressIndeterminate(boolean b)

Description copied from interface: TaskProgressDisplay

Sets the progress display to indicate that the progress cannot be determined, but the task is proceding as normal.

Specified by:

setProgressIndeterminate in interface TaskProgressDisplay

Parameters:

b - true if the progress is indeterminate, or false if the progress is not indeterminate.

setMessage

public void setMessage(String message)

Description copied from interface: TaskProgressDisplay

Sets the message that will be displayed to the user.

Specified by:

setMessage in interface TaskProgressDisplay

setSubTaskMessage

public void setSubTaskMessage(String message)

Specified by:

setSubTaskMessage in interface TaskProgressDisplay

end

public void end()

Description copied from interface: TaskProgressDisplay

Stops (hides) the progress display. This methods is generally called when the task is complete.

Specified by:

end in interface TaskProgressDisplay

getDisplayDelay

public long getDisplayDelay()

Description copied from interface: TaskProgressDisplay

Gets the length of time between the task starting and the progress display being displayed.

Specified by:

getDisplayDelay in interface TaskProgressDisplay

Returns:

The delay in milliseconds.

isModal

public boolean isModal()

Description copied from interface: TaskProgressDisplay

Determines whether or not the progress display is modal and therfore blocks the main event pump when run() is called. For example if the progress display is a modal JDialog then this method should return true since showing the progress display will block user input until the task has finished and end() is called. In general, any Swing progress display should be modal.

Specified by:

isModal in interface TaskProgressDisplay