oracle.javatools.dialogs

Class ProgressMonitor

java.lang.Object

oracle.javatools.dialogs.ProgressMonitor

Deprecated.

replaced by oracle.javatools.dialogs.progress.ProgressMonitor and related classes.

public class ProgressMonitor
extends java.lang.Object

A class to monitor the progress of some operation, based on Swing's ProgressMonitor. This implementation conforms to UI specifications and offers the following additional features:

• a configurable title for the progress dialog.
• indeterminate progress indication.
• optional visibility of the progress bar in the dialog.
• an optionally cancellable dialog.
• a section of the dialog for logging the details of actions.

By default, the progress monitor will not use a delay before making the dialog visible. Recommended settings for the popup decision and delay are 500 and 2000 milliseconds respectively. Thread advice - instances of this class should be configured and their methods invoked from a consumer worker thread and not the AWTbasicdo event thread, which must be left free to process events.

See Also:

ProgressMonitor

Constructor Summary

Constructors

Constructor and Description
ProgressMonitor(java.awt.Component parentComponent, java.lang.String title, int min, int max) Deprecated. Constructs a graphic object that shows progress, typically by filling in a rectangular bar as the process nears completion.
ProgressMonitor(java.awt.Component parentComponent, java.lang.String title, java.lang.Object message, java.lang.String note, int min, int max) Deprecated. Constructs a graphic object that shows progress, typically by filling in a rectangular bar as the process nears completion.
ProgressMonitor(java.awt.Component parentComponent, java.lang.String title, java.lang.String message, java.lang.String note, int min, int max) Deprecated. Constructs a graphic object that shows progress, typically by filling in a rectangular bar as the process nears completion.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Deprecated. Indicates that the operation is complete.
void	display() Deprecated. Forces the progress dialog to be displayed, regardless of timing.
java.awt.Component	getDetailContent() Deprecated. Returns the content of the dialog to appear in a 'details' section.
int	getMaximum() Deprecated. Returns the maximum value -- the higher end of the progress value.
int	getMillisToDecideToPopup() Deprecated. Returns the amount of time this object waits before deciding whether or not to popup a progress monitor.
int	getMillisToPopup() Deprecated. Returns the amount of time it will take for the popup to appear.
int	getMinimum() Deprecated. Returns the minimum value -- the lower end of the progress value.
java.lang.String	getNote() Deprecated. Specifies the additional note that is displayed along with the progress message.
boolean	isBarVisible() Deprecated. Returns the visibility of the dialog's progress bar before it is shown.
boolean	isCanceled() Deprecated. Returns true if the user hits the Cancel button in the progress dialog.
boolean	isCancellable() Deprecated. Returns whether the progress dialog can be cancelled.
boolean	isIndeterminate() Deprecated. Returns whether progress indication is indeterminate (busy bar).
void	setBarVisible(boolean barVisible) Deprecated. Specifies the visibility of the dialog's progress bar before it is shown.
void	setCancellable(boolean cancellable) Deprecated. Specifies whether the progress dialog can be cancelled.
void	setDetailContent(java.awt.Component detailContent) Deprecated. Specifies the content of the dialog to appear in a 'details' section.
void	setIndeterminate(boolean indeterminate) Deprecated. Specifies whether progress indication is indeterminate (busy bar).
void	setMaximum(int m) Deprecated. Specifies the maximum value.
void	setMessage(java.lang.String message) Deprecated. Specifies the text for the main process step (displayed above the progress bar).
void	setMillisToDecideToPopup(int millisToDecideToPopup) Deprecated. Specifies the amount of time to wait before deciding whether or not to popup a progress monitor.
void	setMillisToPopup(int millisToPopup) Deprecated. Specifies the amount of time it will take for the popup to appear.
void	setMinimum(int m) Deprecated. Specifies the minimum value.
void	setNote(java.lang.String note) Deprecated. Specifies the additional note that is displayed along with the progress message.
void	setProgress(int nv) Deprecated. Indicates the progress of the operation being monitored.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressMonitor

public ProgressMonitor(java.awt.Component parentComponent,
               java.lang.String title,
               java.lang.Object message,
               java.lang.String note,
               int min,
               int max)

Deprecated.

Constructs a graphic object that shows progress, typically by filling in a rectangular bar as the process nears completion.

Parameters:

parentComponent - the parent component for the dialog box.

title - the title for the dialog box.

message - The main process step: broadly tells the user what step in the overall process is currently being executed. If possible, it includes additional information tracking the process of the step such as time remaining or number of bytes received. Provided you pass a String into this method, you can change the text at any time while the operation proceeds by calling setMessage().

note - a short note describing the state of the operation. As the operation progresses, you can call setNote to change the note displayed. This is used, for example, in operations that iterate through a list of files to show the name of the file being processes. If note is initially null, there will be no note line in the dialog box and setNote will be ineffective.

min - the lower bound of the range.

max - the upper bound of the range.

ProgressMonitor

public ProgressMonitor(java.awt.Component parentComponent,
               java.lang.String title,
               java.lang.String message,
               java.lang.String note,
               int min,
               int max)

Deprecated.

Constructs a graphic object that shows progress, typically by filling in a rectangular bar as the process nears completion.

Parameters:

parentComponent - the parent component for the dialog box.

title - the title for the dialog box.

message - The main process step: broadly tells the user what step in the overall process is currently being executed. If possible, it includes additional information tracking the process of the step such as time remaining or number of bytes received. You can change the text at any time while the operation proceeds by calling setMessage().

note - a short note describing the state of the operation. As the operation progresses, you can call setNote to change the note displayed. This is used, for example, in operations that iterate through a list of files to show the name of the file being processes. If note is initially null, there will be no note line in the dialog box and setNote will be ineffective.

min - the lower bound of the range.

max - the upper bound of the range.

ProgressMonitor

public ProgressMonitor(java.awt.Component parentComponent,
               java.lang.String title,
               int min,
               int max)

Deprecated.

Constructs a graphic object that shows progress, typically by filling in a rectangular bar as the process nears completion.

Parameters:

parentComponent - the parent component for the dialog box.

title - the title for the dialog box.

min - the lower bound of the range.

max - the upper bound of the range.

Method Detail

setProgress

public void setProgress(int nv)

Deprecated.

Indicates the progress of the operation being monitored. If the specified value is >= the maximum, the progress monitor is closed. Do not invoke from the AWT event thread.

Parameters:

nv - an int specifying the current value, between the maximum and minimum specified for this component

See Also:

setMinimum(int), setMaximum(int), close()

close

public void close()

Deprecated.

Indicates that the operation is complete. This happens automatically when the value set by setProgress is >= max, but it may be called earlier if the operation ends early.

getMinimum

public int getMinimum()

Deprecated.

Returns the minimum value -- the lower end of the progress value.

Returns:

an int representing the minimum value

See Also:

setMinimum(int)

setMinimum

public void setMinimum(int m)

Deprecated.

Specifies the minimum value.

Parameters:

m - an int specifying the minimum value

See Also:

getMinimum()

getMaximum

public int getMaximum()

Deprecated.

Returns the maximum value -- the higher end of the progress value.

Returns:

an int representing the maximum value

See Also:

setMaximum(int)

setMaximum

public void setMaximum(int m)

Deprecated.

Specifies the maximum value.

Parameters:

m - an int specifying the maximum value

See Also:

getMaximum()

isCanceled

public boolean isCanceled()

Deprecated.

Returns true if the user hits the Cancel button in the progress dialog.

setMillisToDecideToPopup

public void setMillisToDecideToPopup(int millisToDecideToPopup)

Deprecated.

Specifies the amount of time to wait before deciding whether or not to popup a progress monitor.

Parameters:

millisToDecideToPopup - an int specifying the time to wait, in milliseconds

See Also:

getMillisToDecideToPopup()

getMillisToDecideToPopup

public int getMillisToDecideToPopup()

Deprecated.

Returns the amount of time this object waits before deciding whether or not to popup a progress monitor.

Parameters:

millisToDecideToPopup - an int specifying waiting time, in milliseconds

See Also:

setMillisToDecideToPopup(int)

setMillisToPopup

public void setMillisToPopup(int millisToPopup)

Deprecated.

Specifies the amount of time it will take for the popup to appear. (If the predicted time remaining is less than this time, the popup won't be displayed.)

Parameters:

millisToPopup - an int specifying the time in milliseconds

See Also:

getMillisToPopup()

getMillisToPopup

public int getMillisToPopup()

Deprecated.

Returns the amount of time it will take for the popup to appear.

Parameters:

millisToPopup - an int specifying the time in milliseconds

See Also:

setMillisToPopup(int)

setNote

public void setNote(java.lang.String note)

Deprecated.

Specifies the additional note that is displayed along with the progress message. Used, for example, to show which file the is currently being copied during a multiple-file copy.

Parameters:

note - a String specifying the note to display

See Also:

getNote()

setMessage

public void setMessage(java.lang.String message)

Deprecated.

Specifies the text for the main process step (displayed above the progress bar).

Parameters:

message - the message to display.

getNote

public java.lang.String getNote()

Deprecated.

Specifies the additional note that is displayed along with the progress message.

Returns:

a String specifying the note to display

See Also:

setNote(java.lang.String)

setDetailContent

public void setDetailContent(java.awt.Component detailContent)

Deprecated.

Specifies the content of the dialog to appear in a 'details' section. This part of the dialog is made optionally visible on a button.

Parameters:

detailContent - the detail content component.

See Also:

getDetailContent()

getDetailContent

public java.awt.Component getDetailContent()

Deprecated.

Returns the content of the dialog to appear in a 'details' section.

Returns:

the detail content component.

See Also:

setDetailContent(java.awt.Component)

setBarVisible

public void setBarVisible(boolean barVisible)

Deprecated.

Specifies the visibility of the dialog's progress bar before it is shown.

Parameters:

barVisible - the visibility value.

See Also:

isBarVisible()

isBarVisible

public boolean isBarVisible()

Deprecated.

Returns the visibility of the dialog's progress bar before it is shown.

Returns:

the visibility value.

See Also:

setBarVisible(boolean)

setIndeterminate

public void setIndeterminate(boolean indeterminate)

Deprecated.

Specifies whether progress indication is indeterminate (busy bar).

Parameters:

indeterminate - the indeterminate value.

See Also:

isIndeterminate()

isIndeterminate

public boolean isIndeterminate()

Deprecated.

Returns whether progress indication is indeterminate (busy bar).

Returns:

the indeterminate value.

See Also:

setIndeterminate(boolean)

setCancellable

public void setCancellable(boolean cancellable)

Deprecated.

Specifies whether the progress dialog can be cancelled.

Parameters:

cancellable - the cancellable value.

See Also:

isCancellable()

isCancellable

public boolean isCancellable()

Deprecated.

Returns whether the progress dialog can be cancelled.

Returns:

the cancellable value.

See Also:

setCancellable(boolean)

display

public void display()

Deprecated.

Forces the progress dialog to be displayed, regardless of timing. If consumer code does not update the component with intermittent changes to the progress value, this method should be called to ensure dialog visibility. Do not invoke from the AWT event thread.

See Also:

close()