AbstractProgressIndicatorBase (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.util.UserDataHolderBase
- - com.intellij.openapi.progress.util.AbstractProgressIndicatorBase

All Implemented Interfaces:

ProgressIndicator, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

AbstractProgressIndicatorExBase, DaemonProgressIndicator, ProgressWrapper, StandardProgressIndicatorBase
```
public class AbstractProgressIndicatorBase
extends UserDataHolderBase
implements ProgressIndicator
```

Constructor Summary

Constructors
Constructor and Description

AbstractProgressIndicatorBase()

Constructors
Constructor and Description
`AbstractProgressIndicatorBase()`

Method Summary

All Methods Instance Methods Concrete Methods
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 void`	`dontStartActivity()`
`void`	`finishNonCancelableSection()`
`protected java.lang.Throwable`	`getCancellationTrace()`
`double`	`getFraction()`
`protected java.lang.Object`	`getLock()`
`ModalityState`	`getModalityState()`
`java.lang.String`	`getText()`
`java.lang.String`	`getText2()`
`void`	`initStateFrom(ProgressIndicator indicator)`
`protected boolean`	`isCancelable()`
`boolean`	`isCanceled()`
`boolean`	`isIndeterminate()`
`boolean`	`isModal()`
`boolean`	`isPopupWasShown()`
`protected boolean`	`isReuseable()`
`boolean`	`isRunning()`
`boolean`	`isShowing()`
`void`	`popState()`
`void`	`pushState()`
`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`	`setModalityProgress(ProgressIndicator modalityProgress)` In many implementations, grants to this progress indicator its own modality state.
`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`	`start()` Marks the process as started.
`void`	`startNonCancelableSection()`
`void`	`stop()` Marks the process as finished.
`java.lang.String`	`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

- Constructor Detail
  - AbstractProgressIndicatorBase
```
public AbstractProgressIndicatorBase()
```
- 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
  - isReuseable
```
protected boolean isReuseable()
```
  - 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
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface ProgressIndicator
    
    Returns:
    
    whether the computation associated with this progress indicator is currently running: started, not yet finished, but possibly already canceled.
  - cancel
```
public 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
  - isCanceled
```
public boolean isCanceled()
```
    Specified by:
    
    isCanceled in interface ProgressIndicator
    
    Returns:
    
    whether the process has been canceled. Usually ProgressIndicator.checkCanceled() is called instead.
    
    See Also:
    
    ProgressIndicator.cancel()
  - checkCanceled
```
public 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
  - getCancellationTrace
```
protected java.lang.Throwable getCancellationTrace()
```
  - 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
    
    Parameters:
    
    text - Text to set
    
    See Also:
    
    ProgressIndicator.setText2(String)
  - getText
```
public java.lang.String getText()
```
    Specified by:
    
    getText in interface ProgressIndicator
    
    Returns:
    
    text above the progress bar, set by ProgressIndicator.setText(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
    
    Parameters:
    
    text - Text to set
    
    See Also:
    
    ProgressIndicator.setText(String)
  - getText2
```
public java.lang.String getText2()
```
    Specified by:
    
    getText2 in interface ProgressIndicator
    
    Returns:
    
    text under the progress bar, set by ProgressIndicator.setText2(String)
  - getFraction
```
public double getFraction()
```
    Specified by:
    
    getFraction in interface ProgressIndicator
    
    Returns:
    
    current fraction, set by ProgressIndicator.setFraction(double)
  - 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
    
    See Also:
    
    ProgressIndicator.setIndeterminate(boolean)
  - pushState
```
public void pushState()
```
    Specified by:
    
    pushState in interface ProgressIndicator
  - popState
```
public void popState()
```
    Specified by:
    
    popState in interface ProgressIndicator
  - startNonCancelableSection
```
public void startNonCancelableSection()
```
    Specified by:
    
    startNonCancelableSection in interface ProgressIndicator
  - finishNonCancelableSection
```
public void finishNonCancelableSection()
```
    Specified by:
    
    finishNonCancelableSection in interface ProgressIndicator
  - isCancelable
```
protected boolean isCancelable()
```
  - isModal
```
public final boolean isModal()
```
    Specified by:
    
    isModal in interface ProgressIndicator
    
    Returns:
    
    whether this process blocks user activities while active, probably displaying a modal dialog.
    
    See Also:
    
    ProgressIndicator.setModalityProgress(ProgressIndicator)
  - getModalityState
```
public ModalityState getModalityState()
```
    Specified by:
    
    getModalityState in interface ProgressIndicator
    
    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.
  - setModalityProgress
```
public void setModalityProgress(ProgressIndicator modalityProgress)
```
    Description copied from interface: ProgressIndicator
    
    In many implementations, grants to this progress indicator its own modality state. Don't call unless you know what you're doing. Passing a non-null value can make this indicator modal (as in ProgressIndicator.isModal(), which, if not accompanied by showing a modal dialog, might affect the whole IDE adversely: e.g. actions won't be executed, editor typing won't work, and all that with no visible indication.
    
    Specified by:
    
    setModalityProgress in interface ProgressIndicator
  - isIndeterminate
```
public boolean isIndeterminate()
```
    Specified by:
    
    isIndeterminate in interface ProgressIndicator
    
    Returns:
    
    whether the progress is indeterminate and displays no fractions
  - 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
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isPopupWasShown
```
public boolean isPopupWasShown()
```
    Specified by:
    
    isPopupWasShown in interface ProgressIndicator
  - isShowing
```
public boolean isShowing()
```
    Specified by:
    
    isShowing in interface ProgressIndicator
  - initStateFrom
```
public void initStateFrom(ProgressIndicator indicator)
```
  - dontStartActivity
```
protected void dontStartActivity()
```
  - getLock
```
protected java.lang.Object getLock()
```

Class AbstractProgressIndicatorBase

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

AbstractProgressIndicatorBase

Method Detail

start

isReuseable

stop

isRunning

cancel

isCanceled

checkCanceled

getCancellationTrace

setText

getText

setText2

getText2

getFraction

setFraction

pushState

popState

startNonCancelableSection

finishNonCancelableSection

isCancelable

isModal

getModalityState

setModalityProgress

isIndeterminate

setIndeterminate

toString

isPopupWasShown

isShowing

initStateFrom

dontStartActivity

getLock