Package com.intellij.openapi.progress.util

Class ProgressWrapper

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.progress.util.AbstractProgressIndicatorBase

com.intellij.openapi.progress.util.ProgressWrapper

All Implemented Interfaces:

ProgressIndicator, StandardProgressIndicator, WrappedProgressIndicator, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

SegmentedProgressIndicatorManager.SubTaskProgressIndicator, SensitiveProgressWrapper

public class ProgressWrapper
extends AbstractProgressIndicatorBase
implements WrappedProgressIndicator, StandardProgressIndicator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProgressWrapper(ProgressIndicator original)
protected	ProgressWrapper(ProgressIndicator original, boolean checkCanceledForMe)

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the current process.
void	checkCanceled() Usually invoked in the thread associated with this indicator, used to check if the computation performed by this thread has been canceled, and, if yes, stop it immediately (by throwing an exception).
protected java.lang.Throwable	getCancellationTrace()
ModalityState	getModalityState()
ProgressIndicator	getOriginalProgressIndicator()
boolean	isCanceled()
boolean	isIndeterminate()
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
static ProgressIndicator	unwrap(ProgressIndicator indicator)
static ProgressIndicator	unwrapAll(ProgressIndicator indicator)
static ProgressWrapper	wrap(ProgressIndicator indicator)

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

dontStartActivity, finishNonCancelableSection, getFraction, getLock, getText, getText2, initStateFrom, isCancelable, isModal, isPopupWasShown, isReuseable, isRunning, isShowing, popState, pushState, setModalityProgress, start, startNonCancelableSection, stop, toString

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

finishNonCancelableSection, getFraction, getText, getText2, isModal, isPopupWasShown, isRunning, isShowing, popState, pushState, setModalityProgress, start, startNonCancelableSection, stop

Constructor Detail

ProgressWrapper

protected ProgressWrapper(ProgressIndicator original)

ProgressWrapper

protected ProgressWrapper(ProgressIndicator original,
                          boolean checkCanceledForMe)

Method Detail

cancel

public final void cancel()

Description copied from interface: ProgressIndicator

Cancels the current process. Is usually invoked not by the process itself, but by some external activity: e.g. a handler for a "Cancel" button pressed by the user (for visible processes), or by some other event handler which recognizes that the process makes no sense.

Specified by:

cancel in interface ProgressIndicator

Overrides:

cancel in class AbstractProgressIndicatorBase

isCanceled

public final boolean isCanceled()

Specified by:

isCanceled in interface ProgressIndicator

Overrides:

isCanceled in class AbstractProgressIndicatorBase

Returns:

whether the process has been canceled. Usually ProgressIndicator.checkCanceled() is called instead.

See Also:

ProgressIndicator.cancel()

getCancellationTrace

protected java.lang.Throwable getCancellationTrace()

Overrides:

getCancellationTrace in class AbstractProgressIndicatorBase

checkCanceled

public final void checkCanceled()

Description copied from interface: ProgressIndicator

Usually invoked in the thread associated with this indicator, used to check if the computation performed by this thread has been canceled, and, if yes, stop it immediately (by throwing an exception). Threads should call this frequently to allow for prompt cancellation. Failure to do this can cause UI freezes.

You might also want to use ProgressManager.checkCanceled() where you don't need to know current indicator and pass it around.

Specified by:

checkCanceled in interface ProgressIndicator

Overrides:

checkCanceled in class AbstractProgressIndicatorBase

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 AbstractProgressIndicatorBase

Parameters:

text - Text to set

See Also:

ProgressIndicator.setText2(String)

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 AbstractProgressIndicatorBase

Parameters:

text - Text to set

See Also:

ProgressIndicator.setText(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 AbstractProgressIndicatorBase

See Also:

ProgressIndicator.setIndeterminate(boolean)

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 AbstractProgressIndicatorBase

isIndeterminate

public boolean isIndeterminate()

Specified by:

isIndeterminate in interface ProgressIndicator

Overrides:

isIndeterminate in class AbstractProgressIndicatorBase

Returns:

whether the progress is indeterminate and displays no fractions

getModalityState

public ModalityState getModalityState()

Specified by:

getModalityState in interface ProgressIndicator

Overrides:

getModalityState in class AbstractProgressIndicatorBase

Returns:

the modality state returned by ModalityState.defaultModalityState() on threads associated with this progress. By default, depending on implementation, it's ModalityState.NON_MODAL or current modality at the moment of progress indicator creation. It can be later modified by ProgressIndicator.setModalityProgress(ProgressIndicator), but it mostly makes sense for processes showing modal dialogs.

getOriginalProgressIndicator

public ProgressIndicator getOriginalProgressIndicator()

Specified by:

getOriginalProgressIndicator in interface WrappedProgressIndicator

wrap

public static ProgressWrapper wrap(ProgressIndicator indicator)

unwrap

public static ProgressIndicator unwrap(ProgressIndicator indicator)

unwrapAll

public static ProgressIndicator unwrapAll(ProgressIndicator indicator)