Cytoscape 2.6.2 (c) 2006,2007 ISB, MSKCC, UCSD

cytoscape.task.ui
Class JTask

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 cytoscape.task.ui.JTask
All Implemented Interfaces:
TaskMonitor, ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

public class JTask
extends JDialog
implements TaskMonitor, ActionListener

Common UI element for visually monitoring task progress.

See Also:
Serialized Form

Field Summary
 
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
JTask(Task task, JTaskConfig config)
          Constructor.
 
Method Summary
 void actionPerformed(ActionEvent e)
          Capture All Action Events.
 boolean errorOccurred()
          Returns true if Task Has Encountered An Error.
 boolean haltRequested()
          Returns true if User Has Requested to Halt the Task.
 void setCancel(boolean enable)
          Call to externally control whether the cancel button is enabled or disabled.
 void setDone()
          Indicates that the worker task is done processing.
 void setEstimatedTimeRemaining(long time)
          Sets Estimated Time Remaining.
 void setException(Throwable t, String userErrorMessage)
          Reports an Error in Task Processing.
 void setException(Throwable t, String userErrorMessage, String recoveryTip)
          Indicates to a parent application that a task has encountered an error while processing.
 void setPercentCompleted(int percent)
          Sets Percentage Complete.
 void setStatus(String message)
          Sets the Status Message.
 
Methods inherited from class javax.swing.JDialog
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, update
 
Methods inherited from class java.awt.Dialog
addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, 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, 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, remove, removeAll, removeContainerListener, removeNotify, 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, 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, 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, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JTask

public JTask(Task task,
             JTaskConfig config)
Constructor.

Parameters:
task - Task we are monitoring, and may need to cancel.
config - JTaskConfig Object.
Method Detail

setPercentCompleted

public void setPercentCompleted(int percent)
Sets Percentage Complete. Called by a child task thread.

Specified by:
setPercentCompleted in interface TaskMonitor
Parameters:
percent - Percentage Complete.

setEstimatedTimeRemaining

public void setEstimatedTimeRemaining(long time)
Sets Estimated Time Remaining. Called by a child task thread. Safely queues changes to the Swing Event Dispatch Thread.

Specified by:
setEstimatedTimeRemaining in interface TaskMonitor
Parameters:
time - Time Remaining, in milliseconds.

setException

public void setException(Throwable t,
                         String userErrorMessage)
Reports an Error in Task Processing.

Specified by:
setException in interface TaskMonitor
Parameters:
t - Throwable t.
userErrorMessage - Human Readable Error Message.

setException

public void setException(Throwable t,
                         String userErrorMessage,
                         String recoveryTip)
                  throws IllegalThreadStateException
Description copied from interface: TaskMonitor
Indicates to a parent application that a task has encountered an error while processing.

This method provides a convenient mechanism for reporting errors back to the end-user.

This method is used to report non-recoverable fatal errors, and must be called at the very end of a run() method (for example, in a catch block).

Specified by:
setException in interface TaskMonitor
Parameters:
t - an exception that occurred while processing of the task.
userErrorMessage - a user-presentable error message describing the nature of the exception; may be null.
recoveryTip - a use-presentable tip on how to recover from the error.
Throws:
IllegalThreadStateException - TaskMonitor can only be be called from the thread that invokes the task run().

setDone

public void setDone()
Indicates that the worker task is done processing.


setCancel

public void setCancel(boolean enable)
Call to externally control whether the cancel button is enabled or disabled. This can be used by threads which have some sections that can be canceled and some that can not.

Parameters:
enable - if true, enable the cancel button

setStatus

public void setStatus(String message)
Sets the Status Message. Called by a child task thread. Safely queues changes to the Swing Event Dispatch Thread.

Specified by:
setStatus in interface TaskMonitor
Parameters:
message - status message.

errorOccurred

public boolean errorOccurred()
Returns true if Task Has Encountered An Error.

Returns:
boolean value.

haltRequested

public boolean haltRequested()
Returns true if User Has Requested to Halt the Task.

Returns:
boolean value.

actionPerformed

public void actionPerformed(ActionEvent e)
Capture All Action Events. This method is called by the Timer and by User Buttons. This method is called on the Swing Event Dispatch Thread.

Specified by:
actionPerformed in interface ActionListener
Parameters:
e - Timer Event.

www.cytoscape.org