orthotweezers
Class ExecuteDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--orthotweezers.ExecuteDialog

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.lang.Runnable, java.io.Serializable, javax.swing.WindowConstants

Direct Known Subclasses:

Calibrate, GraspBlock, RunScript, SeekZSurface, UsePythonConsole

public class ExecuteDialog

extends javax.swing.JDialog

implements java.lang.Runnable

An ExecuteDialog provides a dialog box with a Go and Cancel button. When Go is clicked, a new CancelThread is created and the code in the execute() method is called. A subclass should override execute(). If the Cancel button is pushed, execute() will throw a CancelException which will terminate the thread.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Inner classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Inner classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Inner classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Inner classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

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

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

ExecuteDialog(java.awt.Frame parent, java.lang.String title, java.lang.String goButtonText, java.lang.String initialStatus)
Creates new ExecuteDialog.

ExecuteDialog(java.awt.Frame parent, java.lang.String title, java.lang.String goButtonText, java.lang.String initialStatus, boolean executeImmediately)
Creates new ExecuteDialog.

Method Summary

void	execute() This is called once the Go button is pressed and runs in a new thread.
void	run() This is run in a separate thread and calls execute() and catches a possible CancelException.
void	setCancelMessage(java.lang.String cancelMessage) Usually when the user clicks Cancel, the executing thread will catch it and exit immediately.
void	setStatus(java.lang.String text) Set the status label to the given text.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setLocationRelativeTo, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Dialog

addNotify, dispose, getTitle, hide, isModal, isResizable, setModal, setResizable, setTitle, show

Methods inherited from class java.awt.Window

addWindowListener, applyResourceBundle, applyResourceBundle, finalize, getFocusOwner, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFont, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, 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, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecuteDialog

public ExecuteDialog(java.awt.Frame parent,
                     java.lang.String title,
                     java.lang.String goButtonText,
                     java.lang.String initialStatus,
                     boolean executeImmediately)

Creates new ExecuteDialog.

Parameters:

parent - The parent Frame

title - The string to display in the dialog box title bar

goButtonText - The name to set the Go button to

initialStatus - The initial string for the status label.

executeImmediately - If false, then the user must click the "go" button to begin executing. If true, this begins executing as soon as the dialog box is visible.

ExecuteDialog

public ExecuteDialog(java.awt.Frame parent,
                     java.lang.String title,
                     java.lang.String goButtonText,
                     java.lang.String initialStatus)

Creates new ExecuteDialog. This does not execute immediately, but waits for the user to click the "go" button.

Parameters:

parent - The parent Frame

title - The string to display in the dialog box title bar

goButtonText - The name to set the Go button to

initialStatus - The initial string for the status label.

Method Detail

setCancelMessage

public void setCancelMessage(java.lang.String cancelMessage)

Usually when the user clicks Cancel, the executing thread will catch it and exit immediately. But if it doesn't you may want to use this to set the message which will be printed to System.out while waiting for the running thread to exit. Perhaps this could be a message to tell the user something to do to make sure the running thread can get to a place to call CancelThread.check().

run

public void run()

This is run in a separate thread and calls execute() and catches a possible CancelException.

Specified by:

run in interface java.lang.Runnable

See Also:

execute()

execute

public void execute()
             throws CancelException

This is called once the Go button is pressed and runs in a new thread. It is expected that a subclass will override this method. The user may cancel this thread by pressing the Cancel button. Therefore, this method can throw a CancelException. This method, or the methods it calls, should periodically call CancelThread.check() in order to check for the cancel condition. Note that execute() can call setStatus() to display a status message in the dialog box. When finished, execute() should call something like setStatus("done").

Throws:

CancelException -

See Also:

CancelThread.check()

setStatus

public void setStatus(java.lang.String text)

Set the status label to the given text. This can be called from execute() to display information in the dialog box while running.