Package com.intellij.openapi.progress.util

Class ProgressIndicatorBase

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

All Implemented Interfaces:

ProgressIndicator, StandardProgressIndicator, UserDataHolder, UserDataHolderEx, ProgressIndicatorEx

Direct Known Subclasses:

AbstractStepWithProgress.MyProgressIndicator, CompletionProgressIndicator, InlineProgressIndicator, PanelProgressIndicator, ProgressWindow, StatusBarProgress

public class ProgressIndicatorBase
extends AbstractProgressIndicatorExBase
implements StandardProgressIndicator

Nested Class Summary

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

AbstractProgressIndicatorExBase.IndicatorAction

Constructor Summary

Constructors

Constructor and Description
ProgressIndicatorBase()
ProgressIndicatorBase(boolean reusable)
ProgressIndicatorBase(boolean reusable, boolean allowSystemActivity)

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the current process.
boolean	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, setFraction, setIndeterminate, setOwnerTask, setText, setText2, start, stop, wasStarted

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

dontStartActivity, finishNonCancelableSection, getCancellationTrace, getFraction, getLock, getModalityState, getText, getText2, initStateFrom, isCancelable, isIndeterminate, isModal, isPopupWasShown, isRunning, isShowing, setModalityProgress, startNonCancelableSection, 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

checkCanceled, finishNonCancelableSection, getFraction, getModalityState, getText, getText2, isIndeterminate, isModal, isPopupWasShown, isRunning, isShowing, popState, pushState, setFraction, setIndeterminate, setModalityProgress, setText, setText2, start, startNonCancelableSection, stop

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

initStateFrom

Constructor Detail

ProgressIndicatorBase

public ProgressIndicatorBase()

ProgressIndicatorBase

public ProgressIndicatorBase(boolean reusable)

ProgressIndicatorBase

public ProgressIndicatorBase(boolean reusable,
                             boolean allowSystemActivity)

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 AbstractProgressIndicatorExBase

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