Package com.intellij.openapi.progress.util

Class StandardProgressIndicatorBase

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.progress.util.AbstractProgressIndicatorBase

com.intellij.openapi.progress.util.StandardProgressIndicatorBase

All Implemented Interfaces:

ProgressIndicator, StandardProgressIndicator, UserDataHolder, UserDataHolderEx

public class StandardProgressIndicatorBase
extends AbstractProgressIndicatorBase
implements StandardProgressIndicator

Constructor Summary

Constructors

Constructor and Description
StandardProgressIndicatorBase()

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.AbstractProgressIndicatorBase

checkCanceled, dontStartActivity, finishNonCancelableSection, getCancellationTrace, getFraction, getLock, getModalityState, getText, getText2, initStateFrom, isCancelable, isIndeterminate, isModal, isPopupWasShown, isReuseable, isRunning, isShowing, popState, pushState, setFraction, setIndeterminate, setModalityProgress, setText, setText2, 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

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

Constructor Detail

StandardProgressIndicatorBase

public StandardProgressIndicatorBase()

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