oracle.javatools.dialogs.progress
Class IndeterminateProgressMonitor

java.lang.Object
  oracle.javatools.dialogs.progress.IndeterminateProgressMonitor

public class IndeterminateProgressMonitor
extends java.lang.Object

A progress monitor implementation for indeterminate progress feedback.

See Also:

DeterminateProgressMonitor

Constructor Summary

IndeterminateProgressMonitor(java.awt.Component parent, java.lang.String title)

IndeterminateProgressMonitor(java.awt.Component parent, java.lang.String title, java.lang.Object message, java.lang.String note)

Method Summary

void	close() Indicates that the operation is complete.
protected void	closeImpl()
protected javax.swing.JProgressBar	createProgressBar()
void	display() Forces the progress dialog to be displayed, regardless of timing.
protected void	displayImpl()
void	finish() Finishes progress indication by setting the level to its maximum ahead of monitor closure.
protected void	finishImpl(javax.swing.JProgressBar progressBar)
boolean	getCloseOnFinish() Asks whether the monitor's dialog will close when responding to the finish() method.
java.awt.Component	getComponent() Gets the progress monitor dialog component, if created.
java.awt.Component	getDetailContent() Returns the content of the dialog to appear in a 'details' section.
int	getMillisToPopup() Returns the amount of time it will take for the popup to appear.
ProgressPanel	getPanel() Gets the panel component for this progress monitor.
boolean	isBarVisible() Returns the visibility of the dialog's progress bar before it is shown.
boolean	isCanceled() Returns true if the user hits the Cancel button in the progress dialog.
boolean	isCancellable() Returns whether the progress dialog can be cancelled.
boolean	isCancelled() Returns true if the user hits the Cancel button in the progress dialog.
boolean	isDetailVisible() Gets whether the dialog detail content is made visible by default.
void	setBarVisible(boolean barVisible) Specifies the visibility of the dialog's progress bar before it is shown.
void	setCancellable(boolean cancellable) Specifies whether the progress dialog can be cancelled.
void	setCloseOnFinish(boolean closeOnFinish) Sets whether the monitor's dialog should close when responding to the finish() method.
void	setDetailContent(java.awt.Component detailContent) Specifies the content of the dialog to appear in a 'details' section.
void	setDetailVisible(boolean detailVisible) Sets whether the dialog detail content is made visible by default.
void	setMillisToPopup(int millisToPopup) Specifies the amount of time it will take for the popup to appear.
void	start() Starts the monitor, ensuring the dialog will be displayed after the configured delay.
void	uncancel() Resets the cancelled state of the progress dialog.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndeterminateProgressMonitor

public IndeterminateProgressMonitor(java.awt.Component parent,
                                    java.lang.String title)

IndeterminateProgressMonitor

public IndeterminateProgressMonitor(java.awt.Component parent,
                                    java.lang.String title,
                                    java.lang.Object message,
                                    java.lang.String note)

Method Detail

start

public void start()

Starts the monitor, ensuring the dialog will be displayed after the configured delay.

createProgressBar

protected javax.swing.JProgressBar createProgressBar()

displayImpl

protected void displayImpl()

finishImpl

protected void finishImpl(javax.swing.JProgressBar progressBar)

closeImpl

protected void closeImpl()

setCloseOnFinish

public void setCloseOnFinish(boolean closeOnFinish)

Sets whether the monitor's dialog should close when responding to the finish() method. By default, this is true.

Parameters:

closeOnFinish - a decision on dialog closure.

getCloseOnFinish

public boolean getCloseOnFinish()

Asks whether the monitor's dialog will close when responding to the finish() method.

Returns:

a verdict on dialog closure.

finish

public void finish()

Finishes progress indication by setting the level to its maximum ahead of monitor closure.

close

public void close()

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.

isCanceled

public boolean isCanceled()

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

setMillisToPopup

public void setMillisToPopup(int millisToPopup)

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()

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

Returns:

millisToPopup an int specifying the time in milliseconds

See Also:

setMillisToPopup(int)

setDetailContent

public void setDetailContent(java.awt.Component detailContent)

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()

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

Returns:

the detail content component.

See Also:

setDetailContent(java.awt.Component)

setDetailVisible

public void setDetailVisible(boolean detailVisible)

Sets whether the dialog detail content is made visible by default.

Parameters:

detailVisible - true if dialog detail will be made visible.

isDetailVisible

public boolean isDetailVisible()

Gets whether the dialog detail content is made visible by default.

Returns:

true if dialog detail will be made visible.

setBarVisible

public void setBarVisible(boolean barVisible)

Specifies the visibility of the dialog's progress bar before it is shown. By default, this is true.

Parameters:

barVisible - the visibility value.

See Also:

isBarVisible()

isBarVisible

public boolean isBarVisible()

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

Returns:

the visibility value.

See Also:

setBarVisible(boolean)

setCancellable

public void setCancellable(boolean cancellable)

Specifies whether the progress dialog can be cancelled. By default, this is true.

Parameters:

cancellable - the cancellable value.

See Also:

isCancellable()

isCancellable

public boolean isCancellable()

Returns whether the progress dialog can be cancelled.

Returns:

the cancellable value.

See Also:

setCancellable(boolean)

display

public void display()

Forces the progress dialog to be displayed, regardless of timing. Do not invoke from the AWT event thread.

See Also:

close()

getComponent

public java.awt.Component getComponent()

Gets the progress monitor dialog component, if created.

Returns:

the dialog component.

isCancelled

public boolean isCancelled()

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

Returns:

the cancellation value.

uncancel

public void uncancel()

Resets the cancelled state of the progress dialog. The cancel button will be re-enabled if the user has previously cancelled the dialog.

getPanel

public ProgressPanel getPanel()

Gets the panel component for this progress monitor.

Returns:

the progress panel.