Package com.intellij.formatting

Class FormattingProgressTask

java.lang.Object

com.intellij.openapi.progress.Task

com.intellij.openapi.progress.Task.Modal

com.intellij.util.SequentialModalProgressTask

com.intellij.formatting.FormattingProgressTask

All Implemented Interfaces:

FormattingProgressCallback, Progressive, TaskInfo

public class FormattingProgressTask
extends SequentialModalProgressTask
implements FormattingProgressCallback

Nested Class Summary

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

Task.Backgroundable, Task.ConditionalModal, Task.Modal, Task.NotificationInfo, Task.WithResult<T,E extends java.lang.Exception>

Nested classes/interfaces inherited from interface com.intellij.formatting.FormattingProgressCallback

FormattingProgressCallback.EventType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.ThreadLocal<java.lang.Boolean>	FORMATTING_CANCELLED_FLAG

Fields inherited from class com.intellij.openapi.progress.Task

myProject

Fields inherited from interface com.intellij.formatting.FormattingProgressCallback

EMPTY

Constructor Summary

Constructors

Constructor and Description
FormattingProgressTask(Project project, PsiFile file, Document document)

Method Summary

Modifier and Type	Method and Description
boolean	addCallback(FormattingProgressCallback.EventType eventType, java.lang.Runnable callback) Allows to register callback for the target event type.
void	afterApplyingChange(LeafBlockWrapper block) Notifies current indicator that change from the given wrapped code block is successfully flushed to the underlying document.
void	afterProcessingBlock(LeafBlockWrapper block) Notifies current indicator that given wrapped code block is processed, i.e.
void	afterWrappingBlock(LeafBlockWrapper wrapped) Notifies current indicator that particular code block is wrapped.
void	beforeApplyingFormatChanges(java.util.Collection<LeafBlockWrapper> modifiedBlocks) Notifies current indicator that changes from the given wrapped code blocks are about to be flushed to the underlying document.
void	onCancel() This callback will be invoked on AWT dispatch thread.
void	onSuccess() This callback will be invoked on AWT dispatch thread.
void	onThrowable(java.lang.Throwable error) This callback will be invoked on AWT dispatch thread.
protected void	prepare(SequentialTask task) Executes preliminary jobs prior to the target sequential task processing (SequentialTask.prepare() by default).

Methods inherited from class com.intellij.util.SequentialModalProgressTask

doRun, getIndicator, run, setMinIterationTime, setTask

Methods inherited from class com.intellij.openapi.progress.Task.Modal

isModal

Methods inherited from class com.intellij.openapi.progress.Task

asBackgroundable, asModal, getCancelText, getCancelTooltipText, getNotificationInfo, getProject, getTitle, isCancellable, isHeadless, notifyFinished, onError, onFinished, queue, setCancelText, setCancelTooltipText, setTitle, whereToRunCallbacks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.intellij.formatting.FormattingProgressCallback

setTask

Field Detail

FORMATTING_CANCELLED_FLAG

public static final java.lang.ThreadLocal<java.lang.Boolean> FORMATTING_CANCELLED_FLAG

Constructor Detail

FormattingProgressTask

public FormattingProgressTask(Project project,
                              PsiFile file,
                              Document document)

Method Detail

prepare

protected void prepare(SequentialTask task)

Description copied from class: SequentialModalProgressTask

Executes preliminary jobs prior to the target sequential task processing (SequentialTask.prepare() by default).

Overrides:

prepare in class SequentialModalProgressTask

Parameters:

task - task to be executed

addCallback

public boolean addCallback(FormattingProgressCallback.EventType eventType,
                           java.lang.Runnable callback)

Description copied from interface: FormattingProgressCallback

Allows to register callback for the target event type.

Specified by:

addCallback in interface FormattingProgressCallback

Parameters:

eventType - target event type

callback - callback to register for the given event type

Returns:

true if given callback is successfully registered for the given event type; false otherwise

onSuccess

public void onSuccess()

Description copied from class: Task

This callback will be invoked on AWT dispatch thread.

Overrides:

onSuccess in class Task

onCancel

public void onCancel()

Description copied from class: Task

This callback will be invoked on AWT dispatch thread. Callback executed when run() throws ProcessCanceledException or if its ProgressIndicator was canceled.

Overrides:

onCancel in class Task

onThrowable

public void onThrowable(java.lang.Throwable error)

Description copied from class: Task

This callback will be invoked on AWT dispatch thread.

Callback executed when Progressive.run(ProgressIndicator) throws an exception (except ProcessCanceledException).

Overrides:

onThrowable in class Task

afterWrappingBlock

public void afterWrappingBlock(LeafBlockWrapper wrapped)

Description copied from interface: FormattingProgressCallback

Notifies current indicator that particular code block is wrapped.

Specified by:

afterWrappingBlock in interface FormattingProgressCallback

Parameters:

wrapped - wrapped code block

See Also:

FormattingStateId.WRAPPING_BLOCKS

afterProcessingBlock

public void afterProcessingBlock(LeafBlockWrapper block)

Description copied from interface: FormattingProgressCallback

Notifies current indicator that given wrapped code block is processed, i.e. its white space is adjusted as necessary.

Specified by:

afterProcessingBlock in interface FormattingProgressCallback

Parameters:

block - processed wrapped block which white space if adjusted

See Also:

FormattingStateId.PROCESSING_BLOCKS

beforeApplyingFormatChanges

public void beforeApplyingFormatChanges(java.util.Collection<LeafBlockWrapper> modifiedBlocks)

Description copied from interface: FormattingProgressCallback

Notifies current indicator that changes from the given wrapped code blocks are about to be flushed to the underlying document.

Specified by:

beforeApplyingFormatChanges in interface FormattingProgressCallback

Parameters:

modifiedBlocks - blocks with modified white spaces which are about to be flushed to the underlying document

See Also:

FormattingStateId.APPLYING_CHANGES

afterApplyingChange

public void afterApplyingChange(LeafBlockWrapper block)

Description copied from interface: FormattingProgressCallback

Notifies current indicator that change from the given wrapped code block is successfully flushed to the underlying document.

Specified by:

afterApplyingChange in interface FormattingProgressCallback

Parameters:

block - wrapped code block which change is successfully flushed to the underlying document

See Also:

FormattingStateId.APPLYING_CHANGES