Package org.openstreetmap.josm.gui.progress.swing

Class PleaseWaitProgressMonitor

java.lang.Object

org.openstreetmap.josm.gui.progress.AbstractProgressMonitor

org.openstreetmap.josm.gui.progress.swing.PleaseWaitProgressMonitor

All Implemented Interfaces:

ProgressMonitor

public class PleaseWaitProgressMonitor
extends AbstractProgressMonitor

A progress monitor used in PleaseWaitRunnable.

Progress is displayed in a dialog window (PleaseWaitDialog).

Since:

12675 (moved from gui.progress package}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PleaseWaitProgressMonitor.ProgressMonitorDialog	Implemented by both foreground dialog and background progress dialog (in status bar)

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.progress.AbstractProgressMonitor

AbstractProgressMonitor.State

Nested classes/interfaces inherited from interface org.openstreetmap.josm.gui.progress.ProgressMonitor

ProgressMonitor.CancelListener

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	cancelable
private java.awt.event.ActionListener	cancelListener
(package private) static PleaseWaitProgressMonitor	currentProgressMonitor	The progress monitor being currently displayed.
private int	currentProgressValue
private java.lang.String	customText
private PleaseWaitDialog	dialog
private java.awt.Component	dialogParent
private java.awt.event.ActionListener	inBackgroundListener
private boolean	indeterminate
private boolean	isInBackground
static int	PROGRESS_BAR_MAX	The maximum value the progress bar that displays the current progress should have.
protected ProgressTaskId	taskId
private java.lang.String	title
private java.awt.event.WindowListener	windowListener
private java.lang.String	windowTitle

Fields inherited from class org.openstreetmap.josm.gui.progress.AbstractProgressMonitor

state

Fields inherited from interface org.openstreetmap.josm.gui.progress.ProgressMonitor

ALL_TICKS, DEFAULT_TICKS

Constructor Summary

Constructors

Constructor	Description
PleaseWaitProgressMonitor()	Constructs a new PleaseWaitProgressMonitor.
PleaseWaitProgressMonitor(java.awt.Component dialogParent)	Constructs a new PleaseWaitProgressMonitor.
PleaseWaitProgressMonitor(java.awt.Component dialogParent, java.lang.String windowTitle)	Constructs a new PleaseWaitProgressMonitor.
PleaseWaitProgressMonitor(java.lang.String windowTitle)	Constructs a new PleaseWaitProgressMonitor.

Method Summary

Modifier and Type	Method	Description
void	appendLogMessage(java.lang.String message)	Default implementation is empty.
void	close()	Close the progress dialog window.
void	doBeginTask()
void	doFinishTask()
private void	doInEDT(java.lang.Runnable runnable)
protected void	doSetCustomText(java.lang.String title)
protected void	doSetIntermediate(boolean value)
protected void	doSetTitle(java.lang.String title)
static PleaseWaitProgressMonitor	getCurrent()	Returns the progress monitor being currently displayed.
private PleaseWaitProgressMonitor.ProgressMonitorDialog	getDialog()
ProgressTaskId	getProgressTaskId()	Returns the task ID of the progress dialog Should be used only by PleaseWaitRunnable
java.awt.Component	getWindowParent()	Return the parent windows of progress dialog
boolean	isCancelable()	See if this task is cancelable
void	reset()	Update the dialog values
void	setCancelable(boolean cancelable)	Sets this task to be cancelable
private void	setDialogVisible(boolean visible)
void	setProgressTaskId(ProgressTaskId taskId)	Set the task ID of the progress dialog Should be used only by PleaseWaitRunnable.
void	showForegroundDialog()	Show the progress dialog in foreground
java.lang.String	toString()
protected void	updateProgress(double progressValue)	Update progress message

Methods inherited from class org.openstreetmap.josm.gui.progress.AbstractProgressMonitor

addCancelListener, beginTask, beginTask, cancel, checkState, childFinished, childSetCustomText, childSetIntermediate, childSetProgress, childSetTitle, createSubTaskMonitor, finishTask, getTicks, getTicksCount, indeterminateSubTask, invalidate, isCanceled, removeCancelListener, setCustomText, setExtraText, setTicks, setTicksCount, subTask, worked

Methods inherited from class java.lang.Object

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

Field Detail

PROGRESS_BAR_MAX

public static final int PROGRESS_BAR_MAX

The maximum value the progress bar that displays the current progress should have.

See Also:

Constant Field Values

currentProgressMonitor

static PleaseWaitProgressMonitor currentProgressMonitor

The progress monitor being currently displayed.

dialogParent

private final java.awt.Component dialogParent

currentProgressValue

private int currentProgressValue

customText

private java.lang.String customText

title

private java.lang.String title

indeterminate

private boolean indeterminate

isInBackground

private boolean isInBackground

dialog

private PleaseWaitDialog dialog

windowTitle

private java.lang.String windowTitle

taskId

protected ProgressTaskId taskId

cancelable

private boolean cancelable

cancelListener

private final java.awt.event.ActionListener cancelListener

inBackgroundListener

private final java.awt.event.ActionListener inBackgroundListener

windowListener

private final java.awt.event.WindowListener windowListener

Constructor Detail

PleaseWaitProgressMonitor

public PleaseWaitProgressMonitor()

Constructs a new PleaseWaitProgressMonitor.

PleaseWaitProgressMonitor

public PleaseWaitProgressMonitor(java.lang.String windowTitle)

Constructs a new PleaseWaitProgressMonitor.

Parameters:

windowTitle - window title

PleaseWaitProgressMonitor

public PleaseWaitProgressMonitor(java.awt.Component dialogParent)

Constructs a new PleaseWaitProgressMonitor.

Parameters:

dialogParent - component to get parent frame from

PleaseWaitProgressMonitor

public PleaseWaitProgressMonitor(java.awt.Component dialogParent,
                                 java.lang.String windowTitle)

Constructs a new PleaseWaitProgressMonitor.

Parameters:

dialogParent - component to get parent frame from

windowTitle - window title

Method Detail

getCurrent

public static PleaseWaitProgressMonitor getCurrent()

Returns the progress monitor being currently displayed.

Returns:

the progress monitor being currently displayed

Since:

12638

doInEDT

private void doInEDT(java.lang.Runnable runnable)

setDialogVisible

private void setDialogVisible(boolean visible)

getDialog

private PleaseWaitProgressMonitor.ProgressMonitorDialog getDialog()

isCancelable

public final boolean isCancelable()

See if this task is cancelable

Returns:

true if it can be canceled

setCancelable

public final void setCancelable(boolean cancelable)

Sets this task to be cancelable

Parameters:

cancelable - Whether it can be canceled

doBeginTask

public void doBeginTask()

Specified by:

doBeginTask in class AbstractProgressMonitor

doFinishTask

public void doFinishTask()

Specified by:

doFinishTask in class AbstractProgressMonitor

updateProgress

protected void updateProgress(double progressValue)

Description copied from class: AbstractProgressMonitor

Update progress message

Specified by:

updateProgress in class AbstractProgressMonitor

Parameters:

progressValue - The percentage of completion (this and child progress)

doSetCustomText

protected void doSetCustomText(java.lang.String title)

Specified by:

doSetCustomText in class AbstractProgressMonitor

doSetTitle

protected void doSetTitle(java.lang.String title)

Specified by:

doSetTitle in class AbstractProgressMonitor

doSetIntermediate

protected void doSetIntermediate(boolean value)

Specified by:

doSetIntermediate in class AbstractProgressMonitor

appendLogMessage

public void appendLogMessage(java.lang.String message)

Description copied from class: AbstractProgressMonitor

Default implementation is empty. Override in subclasses to display the log messages.

Specified by:

appendLogMessage in interface ProgressMonitor

Overrides:

appendLogMessage in class AbstractProgressMonitor

Parameters:

message - the log message. Ignored if null or white space only.

reset

public void reset()

Update the dialog values

close

public void close()

Close the progress dialog window.

showForegroundDialog

public void showForegroundDialog()

Show the progress dialog in foreground

setProgressTaskId

public void setProgressTaskId(ProgressTaskId taskId)

Description copied from interface: ProgressMonitor

Set the task ID of the progress dialog Should be used only by PleaseWaitRunnable. If taskId <> null then "In background" button will be shown

Parameters:

taskId - the task ID

getProgressTaskId

public ProgressTaskId getProgressTaskId()

Description copied from interface: ProgressMonitor

Returns the task ID of the progress dialog Should be used only by PleaseWaitRunnable

Returns:

the task ID

getWindowParent

public java.awt.Component getWindowParent()

Description copied from interface: ProgressMonitor

Return the parent windows of progress dialog

Returns:

component suitable as parent for dialogs that wants to be shown in front of progress dialog

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object