Package com.intellij.openapi.progress.util

Class ProgressWindow

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.progress.util.AbstractProgressIndicatorBase

com.intellij.openapi.progress.util.AbstractProgressIndicatorExBase

com.intellij.openapi.progress.util.ProgressIndicatorBase

com.intellij.openapi.progress.util.ProgressWindow

All Implemented Interfaces:

Disposable, BlockingProgressIndicator, ProgressIndicator, StandardProgressIndicator, UserDataHolder, UserDataHolderEx, ProgressIndicatorEx

Direct Known Subclasses:

BackgroundableProcessIndicator, DispatchThreadProgressWindow, PotemkinProgress

public class ProgressWindow
extends ProgressIndicatorBase
implements BlockingProgressIndicator, Disposable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProgressWindow.Listener

Nested classes/interfaces inherited from class com.intellij.openapi.progress.util.AbstractProgressIndicatorExBase

AbstractProgressIndicatorExBase.IndicatorAction

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PROGRESS_DIALOG_POSTPONE_TIME_MILLIS This constant defines default delay for showing progress dialog (in millis).
protected boolean	myBackgrounded
static Topic<ProgressWindow.Listener>	TOPIC

Constructor Summary

Constructors

Constructor and Description
ProgressWindow(boolean shouldShowCancel, boolean shouldShowBackground, Project project)
ProgressWindow(boolean shouldShowCancel, boolean shouldShowBackground, Project project, javax.swing.JComponent parentComponent, java.lang.String cancelText)
ProgressWindow(boolean shouldShowCancel, boolean shouldShowBackground, Project project, java.lang.String cancelText)
ProgressWindow(boolean shouldShowCancel, Project project)

Method Summary

Modifier and Type	Method and Description
void	background()
void	dispose() Usually not invoked directly, see class javadoc.
protected com.intellij.openapi.progress.util.ProgressDialog	getDialog()
java.lang.String	getTitle()
protected boolean	isBackgrounded()
boolean	isPopupWasShown()
protected void	prepareShowDialog()
void	pumpEventsForHierarchy()
void	setCancelButtonText(java.lang.String text)
void	setDelayInMillis(int delayInMillis) There is a possible case that many short (in terms of time) progress tasks are executed in a small amount of time.
void	setFraction(double fraction) Sets the fraction: a number between 0.0 and 1.0 reflecting the ratio of work that has already be done (0.0 for nothing, 1.0 for all).
void	setIndeterminate(boolean indeterminate) Marks the progress indeterminate (for processes that can't estimate the amount of work to be done) or determinate (for processes that can display the fraction of the work done using ProgressIndicator.setFraction(double)).
void	setText(java.lang.String text) Sets text above the progress bar
void	setText2(java.lang.String text) Sets text under the progress bar
void	setTitle(java.lang.String title)
protected void	showDialog()
void	start() Marks the process as started.
void	startBlocking()
void	startBlocking(java.lang.Runnable init)
void	stop() Marks the process as finished.
java.lang.String	toString()

Methods inherited from class com.intellij.openapi.progress.util.ProgressIndicatorBase

cancel, isCanceled

Methods inherited from class com.intellij.openapi.progress.util.AbstractProgressIndicatorExBase

addStateDelegate, checkCanceled, delegateProgressChange, delegateRunningChange, finish, isFinished, isReuseable, onProgressChange, onRunningChange, popState, processFinish, pushState, removeAllStateDelegates, removeStateDelegate, setOwnerTask, wasStarted

Methods inherited from class com.intellij.openapi.progress.util.AbstractProgressIndicatorBase

dontStartActivity, finishNonCancelableSection, getCancellationTrace, getFraction, getLock, getModalityState, getText, getText2, initStateFrom, isCancelable, isIndeterminate, isModal, isRunning, isShowing, setModalityProgress, startNonCancelableSection

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.progress.ProgressIndicator

cancel, checkCanceled, finishNonCancelableSection, getFraction, getModalityState, getText, getText2, isCanceled, isIndeterminate, isModal, isRunning, isShowing, popState, pushState, setModalityProgress, startNonCancelableSection

Methods inherited from interface com.intellij.openapi.wm.ex.ProgressIndicatorEx

initStateFrom

Field Detail

DEFAULT_PROGRESS_DIALOG_POSTPONE_TIME_MILLIS

public static final int DEFAULT_PROGRESS_DIALOG_POSTPONE_TIME_MILLIS

This constant defines default delay for showing progress dialog (in millis).

See Also:

setDelayInMillis(int), Constant Field Values

myBackgrounded

protected boolean myBackgrounded

TOPIC

public static final Topic<ProgressWindow.Listener> TOPIC

Constructor Detail

ProgressWindow

public ProgressWindow(boolean shouldShowCancel,
                      Project project)

ProgressWindow

public ProgressWindow(boolean shouldShowCancel,
                      boolean shouldShowBackground,
                      Project project)

ProgressWindow

public ProgressWindow(boolean shouldShowCancel,
                      boolean shouldShowBackground,
                      Project project,
                      java.lang.String cancelText)

ProgressWindow

public ProgressWindow(boolean shouldShowCancel,
                      boolean shouldShowBackground,
                      Project project,
                      javax.swing.JComponent parentComponent,
                      java.lang.String cancelText)

Method Detail

start

public void start()

Description copied from interface: ProgressIndicator

Marks the process as started. Invoked by ProgressManager internals, shouldn't be called from client code unless you know what you're doing.

Specified by:

start in interface ProgressIndicator

Overrides:

start in class AbstractProgressIndicatorExBase

setDelayInMillis

public void setDelayInMillis(int delayInMillis)

There is a possible case that many short (in terms of time) progress tasks are executed in a small amount of time. Problem: UI blinks and looks ugly if we show progress dialog for every such task (every dialog disappears shortly). Solution is to postpone showing progress dialog in assumption that the task may be already finished when it's time to show the dialog.

Default value is DEFAULT_PROGRESS_DIALOG_POSTPONE_TIME_MILLIS

Parameters:

delayInMillis - new delay time in milliseconds

prepareShowDialog

protected void prepareShowDialog()

startBlocking

public void startBlocking()

startBlocking

public void startBlocking(java.lang.Runnable init)

Specified by:

startBlocking in interface BlockingProgressIndicator

pumpEventsForHierarchy

public void pumpEventsForHierarchy()

showDialog

protected void showDialog()

setIndeterminate

public void setIndeterminate(boolean indeterminate)

Description copied from interface: ProgressIndicator

Marks the progress indeterminate (for processes that can't estimate the amount of work to be done) or determinate (for processes that can display the fraction of the work done using ProgressIndicator.setFraction(double)).

Specified by:

setIndeterminate in interface ProgressIndicator

Overrides:

setIndeterminate in class AbstractProgressIndicatorExBase

stop

public void stop()

Description copied from interface: ProgressIndicator

Marks the process as finished. Invoked by ProgressManager internals, shouldn't be called from client code unless you know what you're doing.

Specified by:

stop in interface ProgressIndicator

Overrides:

stop in class AbstractProgressIndicatorExBase

getDialog

protected com.intellij.openapi.progress.util.ProgressDialog getDialog()

background

public void background()

isBackgrounded

protected boolean isBackgrounded()

setText

public void setText(java.lang.String text)

Description copied from interface: ProgressIndicator

Sets text above the progress bar

Specified by:

setText in interface ProgressIndicator

Overrides:

setText in class AbstractProgressIndicatorExBase

Parameters:

text - Text to set

See Also:

ProgressIndicator.setText2(String)

setFraction

public void setFraction(double fraction)

Description copied from interface: ProgressIndicator

Sets the fraction: a number between 0.0 and 1.0 reflecting the ratio of work that has already be done (0.0 for nothing, 1.0 for all). Only works for determinate indicator. The fraction should provide the user with rough estimation of the time left. If that's impossible, consider making the progress indeterminate.

Specified by:

setFraction in interface ProgressIndicator

Overrides:

setFraction in class AbstractProgressIndicatorExBase

See Also:

ProgressIndicator.setIndeterminate(boolean)

setText2

public void setText2(java.lang.String text)

Description copied from interface: ProgressIndicator

Sets text under the progress bar

Specified by:

setText2 in interface ProgressIndicator

Overrides:

setText2 in class AbstractProgressIndicatorExBase

Parameters:

text - Text to set

See Also:

ProgressIndicator.setText(String)

setTitle

public void setTitle(java.lang.String title)

getTitle

public java.lang.String getTitle()

setCancelButtonText

public void setCancelButtonText(java.lang.String text)

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

isPopupWasShown

public boolean isPopupWasShown()

Specified by:

isPopupWasShown in interface ProgressIndicator

Overrides:

isPopupWasShown in class AbstractProgressIndicatorBase

toString

public java.lang.String toString()

Overrides:

toString in class AbstractProgressIndicatorBase