Package com.intellij.openapi.progress.util

Class SmoothProgressAdapter

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

All Implemented Interfaces:

ProgressIndicator, StandardProgressIndicator, WrappedProgressIndicator, UserDataHolder, UserDataHolderEx, ProgressIndicatorEx

public class SmoothProgressAdapter
extends AbstractProgressIndicatorExBase
implements ProgressIndicatorEx, WrappedProgressIndicator, StandardProgressIndicator

Nested Class Summary

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

AbstractProgressIndicatorExBase.IndicatorAction

Constructor Summary

Constructors

Constructor and Description
SmoothProgressAdapter(ProgressIndicator original, Project project)

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the current process.
ProgressIndicator	getOriginalProgressIndicator()
boolean	isCanceled()
boolean	isIndeterminate()
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	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	startBlocking()
void	stop() Marks the process as finished.

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

addStateDelegate, checkCanceled, delegateProgressChange, delegateRunningChange, finish, isFinished, isReuseable, onProgressChange, onRunningChange, popState, processFinish, pushState, removeAllStateDelegates, removeStateDelegate, setOwnerTask, wasStarted

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

dontStartActivity, finishNonCancelableSection, getCancellationTrace, getFraction, getLock, getModalityState, getText, getText2, initStateFrom, isCancelable, 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

addStateDelegate, finish, initStateFrom, isFinished, processFinish, wasStarted

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

checkCanceled, finishNonCancelableSection, getFraction, getModalityState, getText, getText2, isModal, isPopupWasShown, isRunning, isShowing, popState, pushState, setModalityProgress, startNonCancelableSection

Constructor Detail

SmoothProgressAdapter

public SmoothProgressAdapter(ProgressIndicator original,
                             Project project)

Method Detail

getOriginalProgressIndicator

public ProgressIndicator getOriginalProgressIndicator()

Specified by:

getOriginalProgressIndicator in interface WrappedProgressIndicator

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 AbstractProgressIndicatorExBase

isIndeterminate

public boolean isIndeterminate()

Specified by:

isIndeterminate in interface ProgressIndicator

Overrides:

isIndeterminate in class AbstractProgressIndicatorBase

Returns:

whether the progress is indeterminate and displays no fractions

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 AbstractProgressIndicatorExBase

startBlocking

public void startBlocking()

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 AbstractProgressIndicatorExBase

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 AbstractProgressIndicatorExBase

Parameters:

text - Text to set

See Also:

ProgressIndicator.setText2(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 AbstractProgressIndicatorExBase

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 AbstractProgressIndicatorExBase

Parameters:

text - Text to set

See Also:

ProgressIndicator.setText(String)

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