planetj.gui
Class CMProgressDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--planetj.gui.CMDialogJ
                                      |
                                      +--planetj.gui.CMProgressDialog

All Implemented Interfaces:

Accessible, CMTopLevelComponent, ImageObserver, MenuContainer, RootPaneContainer, Serializable, WindowConstants

public class CMProgressDialog

extends CMDialogJ

Insert the type's description here. Creation date: (5/6/02 9:22:48 AM)

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

CMProgressDialog()
Constructor

CMProgressDialog(Dialog owner)
CMProgressDialog constructor comment.

CMProgressDialog(Dialog owner, String title, boolean modal)
CMProgressDialog constructor comment.

CMProgressDialog(Frame frame)
Constructor

CMProgressDialog(Frame owner, boolean modal)
CMProgressDialog constructor comment.

CMProgressDialog(Frame owner, String title)
CMProgressDialog constructor comment.

CMProgressDialog(Frame owner, String title, boolean modal)
CMProgressDialog constructor comment.

Method Summary

void	beginCount(int pIncrement, int pRate, int pMaxValue) Shows the window and starts a thread to begin "counting" progress on the progress bar.
void	beginExponentialCount(int pIncrement, int pInitialRate, int pFactor, int pMaxValue) Shows the window and starts a thread to begin "counting" progress on the progress bar.
String	getMessage() Gets the message to display
void	haltCount() Stops the count and hides the window
void	haltCount(boolean pHideWindow) Stops the count, optionally hiding the window
static void	main(String[] args) main entrypoint - starts the part when it is run as an application
void	reset() Resest the progress bar
void	setMessage(String pMessage) Sets the message to display
void	setVisible(boolean vis) Shows or hides the dialog

Methods inherited from class planetj.gui.CMDialogJ

debugMessage, debugMessage, debugMessage, dispose, getClientProperties, getTimeInMills, getTranslation, getTranslationId, hide, isAlwaysOnTop, newCMDialogJ, putClientProperty, setAlwaysOnTop, setTimeInMills, setTitle, setTranslation, show, showBusyCursor, showDefaultCursor, showException, showException

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, isModal, isResizable, isUndecorated, setModal, setResizable, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, 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, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, 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, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

CMProgressDialog

public CMProgressDialog()

Constructor

CMProgressDialog

public CMProgressDialog(Dialog owner)

CMProgressDialog constructor comment.

Parameters:

owner - java.awt.Dialog

CMProgressDialog

public CMProgressDialog(Dialog owner,
                        String title,
                        boolean modal)

CMProgressDialog constructor comment.

Parameters:

owner - java.awt.Dialog

title - java.lang.String

modal - boolean

CMProgressDialog

public CMProgressDialog(Frame frame)

Constructor

CMProgressDialog

public CMProgressDialog(Frame owner,
                        String title)

CMProgressDialog constructor comment.

Parameters:

owner - java.awt.Frame

title - java.lang.String

CMProgressDialog

public CMProgressDialog(Frame owner,
                        String title,
                        boolean modal)

CMProgressDialog constructor comment.

Parameters:

owner - java.awt.Frame

title - java.lang.String

modal - boolean

CMProgressDialog

public CMProgressDialog(Frame owner,
                        boolean modal)

CMProgressDialog constructor comment.

Parameters:

owner - java.awt.Frame

modal - boolean

Method Detail

beginCount

public void beginCount(int pIncrement,
                       int pRate,
                       int pMaxValue)

Shows the window and starts a thread to begin "counting" progress on the progress bar. Any count currently in progress in halted.

beginExponentialCount

public void beginExponentialCount(int pIncrement,
                                  int pInitialRate,
                                  int pFactor,
                                  int pMaxValue)

Shows the window and starts a thread to begin "counting" progress on the progress bar. The rate of counting slows expontentially - the closer it gets to the end, the slower it goes. Any count currently in progress in halted.

Parameters:

pIncrement - This is the amount the progress bar will be advanced by each time

pInitialRate - The number of milliseconds to wait between each advance of the progress bar (at first)

pFactor - A factor by which the count will be slowed. The bigger the number the slower the count will eventually get. A good default value is 10% of the initial rate.

pMaxValue - The progress bar will not advance beyond this value

getMessage

public String getMessage()

Gets the message to display

haltCount

public void haltCount()

Stops the count and hides the window

haltCount

public void haltCount(boolean pHideWindow)

Stops the count, optionally hiding the window

main

public static void main(String[] args)

main entrypoint - starts the part when it is run as an application

Parameters:

args - java.lang.String[]

reset

public void reset()

Resest the progress bar

setMessage

public void setMessage(String pMessage)

Sets the message to display

setVisible

public void setVisible(boolean vis)

Shows or hides the dialog

Overrides:

setVisible in class CMDialogJ