Cytoscape 2.8.0 API

Class JTask

  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

Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JDialog
Nested classes/interfaces inherited from class java.awt.Dialog
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
Nested classes/interfaces inherited from class java.awt.Window
Nested classes/interfaces inherited from class java.awt.Container
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
Fields inherited from class java.awt.Component
Fields inherited from interface javax.swing.WindowConstants
Fields inherited from interface java.awt.image.ImageObserver
Constructor Summary
JTask(Task task, JTaskConfig config)
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
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


public JTask(Task task,
             JTaskConfig config)

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


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

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


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
time - Time Remaining, in milliseconds.


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

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


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
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.
IllegalThreadStateException - TaskMonitor can only be be called from the thread that invokes the task run().


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


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.

enable - if true, enable the cancel button


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
message - status message.


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

boolean value.


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

boolean value.


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
e - Timer Event.

Cytoscape 2.8.0 API

Copyright 2010 Cytoscape Consortium. All rights reserved.