AbstractProgressIndicatorExBase (Unofficial IntelliJ Community Edition API docs)

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

All Implemented Interfaces:

ProgressIndicator, UserDataHolder, UserDataHolderEx, ProgressIndicatorEx

Direct Known Subclasses:

BgProgressIndicator, ProgressIndicatorBase, SmoothProgressAdapter
```
public class AbstractProgressIndicatorExBase
extends AbstractProgressIndicatorBase
implements ProgressIndicatorEx
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static interface AbstractProgressIndicatorExBase.IndicatorAction

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`AbstractProgressIndicatorExBase.IndicatorAction`

Constructor Summary

Constructors
Constructor and Description

AbstractProgressIndicatorExBase()

AbstractProgressIndicatorExBase(boolean reusable)

Constructors
Constructor and Description
`AbstractProgressIndicatorExBase()`
`AbstractProgressIndicatorExBase(boolean reusable)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStateDelegate(ProgressIndicatorEx delegate)`
`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`	`delegateProgressChange(AbstractProgressIndicatorExBase.IndicatorAction action)`
`protected void`	`delegateRunningChange(AbstractProgressIndicatorExBase.IndicatorAction action)`
`void`	`finish(TaskInfo task)`
`boolean`	`isFinished(TaskInfo task)`
`protected boolean`	`isReuseable()`
`protected void`	`onProgressChange()`
`protected void`	`onRunningChange()`
`void`	`popState()`
`void`	`processFinish()`
`void`	`pushState()`
`protected void`	`removeAllStateDelegates()`
`void`	`removeStateDelegate(ProgressIndicatorEx delegate)`
`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)`).
`protected void`	`setOwnerTask(TaskInfo owner)`
`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`	`stop()` Marks the process as finished.
`boolean`	`wasStarted()`

Methods inherited from class com.intellij.openapi.progress.util.AbstractProgressIndicatorBase
dontStartActivity, finishNonCancelableSection, getCancellationTrace, getFraction, getLock, getModalityState, getText, getText2, initStateFrom, isCancelable, isCanceled, 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.wm.ex.ProgressIndicatorEx
initStateFrom

Methods inherited from interface com.intellij.openapi.progress.ProgressIndicator
finishNonCancelableSection, getFraction, getModalityState, getText, getText2, isCanceled, isIndeterminate, isModal, isPopupWasShown, isRunning, isShowing, setModalityProgress, startNonCancelableSection

- Constructor Detail
  - AbstractProgressIndicatorExBase
```
public AbstractProgressIndicatorExBase(boolean reusable)
```
  - AbstractProgressIndicatorExBase
```
public AbstractProgressIndicatorExBase()
```
- 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 AbstractProgressIndicatorBase
  - 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 AbstractProgressIndicatorBase
  - 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
    
    Overrides:
    
    cancel in class AbstractProgressIndicatorBase
  - finish
```
public void finish(TaskInfo task)
```
    Specified by:
    
    finish in interface ProgressIndicatorEx
  - isFinished
```
public boolean isFinished(TaskInfo task)
```
    Specified by:
    
    isFinished in interface ProgressIndicatorEx
  - setOwnerTask
```
protected void setOwnerTask(TaskInfo owner)
```
  - processFinish
```
public void processFinish()
```
    Specified by:
    
    processFinish in interface ProgressIndicatorEx
  - 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)
  - pushState
```
public void pushState()
```
    Specified by:
    
    pushState in interface ProgressIndicator
    
    Overrides:
    
    pushState in class AbstractProgressIndicatorBase
  - popState
```
public void popState()
```
    Specified by:
    
    popState in interface ProgressIndicator
    
    Overrides:
    
    popState in class AbstractProgressIndicatorBase
  - isReuseable
```
protected boolean isReuseable()
```
    Overrides:
    
    isReuseable in class AbstractProgressIndicatorBase
  - 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
  - addStateDelegate
```
public final void addStateDelegate(ProgressIndicatorEx delegate)
```
    Specified by:
    
    addStateDelegate in interface ProgressIndicatorEx
  - removeStateDelegate
```
public final void removeStateDelegate(ProgressIndicatorEx delegate)
```
  - removeAllStateDelegates
```
protected final void removeAllStateDelegates()
```
  - delegateProgressChange
```
protected void delegateProgressChange(AbstractProgressIndicatorExBase.IndicatorAction action)
```
  - delegateRunningChange
```
protected void delegateRunningChange(AbstractProgressIndicatorExBase.IndicatorAction action)
```
  - onProgressChange
```
protected void onProgressChange()
```
  - onRunningChange
```
protected void onRunningChange()
```
  - wasStarted
```
public boolean wasStarted()
```
    Specified by:
    
    wasStarted in interface ProgressIndicatorEx

Class AbstractProgressIndicatorExBase

Nested Class Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

AbstractProgressIndicatorExBase

AbstractProgressIndicatorExBase

Method Detail

start

stop

cancel

finish

isFinished

setOwnerTask

processFinish

checkCanceled

setText

setText2

setFraction

pushState

popState

isReuseable

setIndeterminate

addStateDelegate

removeStateDelegate

removeAllStateDelegates

delegateProgressChange

delegateRunningChange

onProgressChange

onRunningChange

wasStarted