Package com.intellij.formatting

Interface FormattingProgressCallback

All Known Implementing Classes:

FormattingProgressTask

public interface FormattingProgressCallback

Defines common interface for receiving events about formatting progress.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FormattingProgressCallback.EventType

Field Summary

Fields

Modifier and Type	Field and Description
static FormattingProgressCallback	EMPTY Null object for FormattingProgressCallback.

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	setTask(SequentialTask task) Allows to define an actual formatting task to process.

Field Detail

EMPTY

static final FormattingProgressCallback EMPTY

Null object for FormattingProgressCallback.

Method Detail

afterWrappingBlock

void afterWrappingBlock(LeafBlockWrapper wrapped)

Notifies current indicator that particular code block is wrapped.

Parameters:

wrapped - wrapped code block

See Also:

FormattingStateId.WRAPPING_BLOCKS

afterProcessingBlock

void afterProcessingBlock(LeafBlockWrapper block)

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

Parameters:

block - processed wrapped block which white space if adjusted

See Also:

FormattingStateId.PROCESSING_BLOCKS

beforeApplyingFormatChanges

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.

Parameters:

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

See Also:

FormattingStateId.APPLYING_CHANGES

afterApplyingChange

void afterApplyingChange(LeafBlockWrapper block)

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

Parameters:

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

See Also:

FormattingStateId.APPLYING_CHANGES

setTask

void setTask(SequentialTask task)

Allows to define an actual formatting task to process.

I.e. the general idea is that given indicator is provided with the task which will be executed from EDT part by part until the task is finished. That 'part-by-part' processing is assumed to update current indicator (call 'beforeXxx()' and 'afterXxx()' methods).

Parameters:

task - formatter task to process

addCallback

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

Allows to register callback for the target event type.

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