com.isti.util.gui

Class ProgressDialog

java.lang.Object

com.isti.util.gui.IstiDialogPopup

com.isti.util.gui.ProgressDialog

All Implemented Interfaces:

IstiDialogInterface, javax.swing.WindowConstants

public class ProgressDialog
extends IstiDialogPopup

Class ProgressDialog is a dialog with a progress bar.

Nested Class Summary

Nested classes/interfaces inherited from class com.isti.util.gui.IstiDialogPopup

IstiDialogPopup.CloseListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CANCEL_STR Name string for "Cancel" button.

Fields inherited from class com.isti.util.gui.IstiDialogPopup

CANCEL_OPTION, CLOSED_OPTION, DEFAULT_OPTION, DISPOSE_ON_CLOSE, disposeDialogOnButtonFlag, dlgObj, DO_NOTHING_ON_CLOSE, enforceDispatchThreadFlag, ERROR_MESSAGE, HIDE_ON_CLOSE, hideDialogOnButtonFlag, INFORMATION_MESSAGE, initialFocusCompObj, initialFocusFlag, maxHeightLimitFlag, messageString, NO_AUTOBUTTONS_OPTION, NO_OPTION, OK_CANCEL_OPTION, OK_OPTION, optionsArr, packNeededFlag, paneObj, parentHeightLimitFlag, PLAIN_MESSAGE, QUESTION_MESSAGE, repackCheckLocationObj, repackNeededFlag, staticEnforceDispatchThreadFlag, staticMaxHeightLimitFlag, staticParentHeightLimitFlag, waitingForShowFlag, WARNING_MESSAGE, YES_NO_CANCEL_OPTION, YES_NO_OPTION, YES_OPTION

Fields inherited from interface javax.swing.WindowConstants

EXIT_ON_CLOSE

Constructor Summary

Constructors

Constructor and Description
ProgressDialog(java.awt.Component parentComp, java.lang.String titleStr, java.lang.String msgStr) Creates a modal dialog with a progress bar and a "Cancel" button.
ProgressDialog(java.awt.Component parentComp, java.lang.String titleStr, java.lang.String msgStr, java.lang.String buttonStr, boolean modalFlag) Creates a dialog with a progress bar and an optional "Cancel" button.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getButtonString() Returns the text string for the "Cancel" button.
java.lang.Object	getMessageObj() Returns the message object displayed by this dialog.
java.lang.String	getMessageStr() Returns the message string displayed by this dialog.
ProgressIndicatorInterface	getProgressBarObj() Returns the progress-bar object.
void	setMessageObj(java.lang.Object obj) Sets the message object displayed by this dialog.
void	setMessageStr(java.lang.String str) Sets the message object displayed by this dialog to the given string.

Methods inherited from class com.isti.util.gui.IstiDialogPopup

addCloseListener, addComponentListener, addPropertyChangeListener, addPropertyChangeListener, addWindowListener, allowDialogClose, allowDialogClose, close, close, closeWithWait, closeWithWait, createDialog, createDialog, dispose, doDelayedRepack, doPack, doSetDialogVisible, doSetVisible, getBackground, getDialogObj, getDisposeDialogOnButtonFlag, getEnforceDispatchThreadFlag, getForeground, getHideDialogOnButtonFlag, getInputValue, getMaxHeightLimit, getOptionPaneObj, getParentHeightLimit, getPreferredSize, getRepackNeededFlag, getStaticEnforceDispatchThreadFlag, getStaticMaxHeightLimit, getStaticParentHeightLimit, getTitleStr, getUserMessageString, getValue, getWindowForComponent, hide, invalidate, isClosed, isModal, isShowIfNotClosed, isShowing, isVisible, pack, removeCloseListener, removeComponentListener, removePropertyChangeListener, removePropertyChangeListener, removeWindowListener, repaint, requestFocus, selectAndShow, setBackground, setDefaultCloseOperation, setDisposeDialogOnButtonFlag, setEnforceDispatchThreadFlag, setForeground, setHideDialogOnButtonFlag, setInitialFocus, setInitialFocusComponent, setLocation, setLocation, setLocationRelativeTo, setMaxHeightLimit, setMinimumSize, setModal, setOptionPaneValue, setParentHeightLimit, setPreferredSize, setRepackNeededFlag, setResizable, setShowIfNotClosed, setSize, setSize, setStaticEnforceDispatchThreadFlag, setStaticMaxHeightLimit, setStaticParentHeightLimit, setTitleStr, setUserMessageString, setVisible, setVisibleViaInvokeLater, show, showAndReturnIndex, showAndWait, showMessageDialog, showMessageDialog, showOptionDialog, showOptionDialog, showOptionDialog, showOptionDialog, showOptionDialog, showOptionDialog, showOptionDialog, showOptionDialog, validate, waitForDialogVisible

Methods inherited from class java.lang.Object

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

Field Detail

CANCEL_STR

public static final java.lang.String CANCEL_STR

Name string for "Cancel" button.

See Also:

Constant Field Values

Constructor Detail

ProgressDialog

public ProgressDialog(java.awt.Component parentComp,
                      java.lang.String titleStr,
                      java.lang.String msgStr)

Creates a modal dialog with a progress bar and a "Cancel" button.

Parameters:

parentComp - the parent component for the popup.

titleStr - the title string for popup window.

msgStr - the message string.

ProgressDialog

public ProgressDialog(java.awt.Component parentComp,
                      java.lang.String titleStr,
                      java.lang.String msgStr,
                      java.lang.String buttonStr,
                      boolean modalFlag)

Creates a dialog with a progress bar and an optional "Cancel" button.

Parameters:

parentComp - the parent component for the popup.

titleStr - the title string for popup window.

msgStr - the message string.

buttonStr - the button string, or null to display no buttons.

modalFlag - true for modal, false for modeless (allows other windows to run).

Method Detail

getButtonString

public java.lang.String getButtonString()

Returns the text string for the "Cancel" button.

Returns:

The text string for the "Cancel" button.

getMessageObj

public final java.lang.Object getMessageObj()

Returns the message object displayed by this dialog.

Specified by:

getMessageObj in interface IstiDialogInterface

Overrides:

getMessageObj in class IstiDialogPopup

Returns:

The message obj.

getMessageStr

public java.lang.String getMessageStr()

Returns the message string displayed by this dialog.

Specified by:

getMessageStr in interface IstiDialogInterface

Overrides:

getMessageStr in class IstiDialogPopup

Returns:

The message String object, or null if a String object could not be retrieved.

getProgressBarObj

public ProgressIndicatorInterface getProgressBarObj()

Returns the progress-bar object.

Returns:

The progress-bar object.

setMessageObj

public void setMessageObj(java.lang.Object obj)

Sets the message object displayed by this dialog.

Specified by:

setMessageObj in interface IstiDialogInterface

Overrides:

setMessageObj in class IstiDialogPopup

Parameters:

obj - the message obj.

setMessageStr

public void setMessageStr(java.lang.String str)

Sets the message object displayed by this dialog to the given string.

Specified by:

setMessageStr in interface IstiDialogInterface

Overrides:

setMessageStr in class IstiDialogPopup

Parameters:

str - the message string.