Package com.intellij.util.progress

Class SubTaskProgressIndicator

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.progress.util.AbstractProgressIndicatorBase

com.intellij.openapi.progress.util.ProgressWrapper

com.intellij.concurrency.SensitiveProgressWrapper

com.intellij.util.progress.SubTaskProgressIndicator

All Implemented Interfaces:

ProgressIndicator, StandardProgressIndicator, WrappedProgressIndicator, UserDataHolder, UserDataHolderEx

public final class SubTaskProgressIndicator
extends SensitiveProgressWrapper

Method Summary

Modifier and Type	Method and Description
void	finished()
double	getFraction()
void	setFraction(double newValue) 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

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

cancel, checkCanceled, getCancellationTrace, getModalityState, getOriginalProgressIndicator, isCanceled, isIndeterminate, unwrap, unwrapAll, wrap

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

dontStartActivity, finishNonCancelableSection, 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, getText, getText2, isModal, isPopupWasShown, isRunning, isShowing, popState, pushState, setModalityProgress, start, startNonCancelableSection, stop

Method Detail

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 ProgressWrapper

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 ProgressWrapper

Parameters:

text - Text to set

See Also:

ProgressIndicator.setText2(String)

setFraction

public void setFraction(double newValue)

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 ProgressWrapper

See Also:

ProgressIndicator.setIndeterminate(boolean)

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 ProgressWrapper

Parameters:

text - Text to set

See Also:

ProgressIndicator.setText(String)

getFraction

public double getFraction()

Specified by:

getFraction in interface ProgressIndicator

Overrides:

getFraction in class AbstractProgressIndicatorBase

Returns:

current fraction, set by ProgressIndicator.setFraction(double)

finished

public void finished()