Package com.intellij.formatting

Class AbstractBlockAlignmentProcessor

java.lang.Object

com.intellij.formatting.AbstractBlockAlignmentProcessor

All Implemented Interfaces:

BlockAlignmentProcessor

Direct Known Subclasses:

LeftEdgeAlignmentProcessor, RightEdgeAlignmentProcessor

public abstract class AbstractBlockAlignmentProcessor
extends java.lang.Object
implements BlockAlignmentProcessor

Nested Class Summary

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

BlockAlignmentProcessor.Context, BlockAlignmentProcessor.Result

Constructor Summary

Constructors

Constructor and Description
AbstractBlockAlignmentProcessor()

Method Summary

Modifier and Type	Method and Description
BlockAlignmentProcessor.Result	applyAlignment(BlockAlignmentProcessor.Context context) Asks current processor to perform alignment processing for the parameters encapsulated at the given context.
protected abstract boolean	applyIndentToTheFirstBlockOnLine(IndentData alignmentAnchorIndent, BlockAlignmentProcessor.Context context) Encapsulates logic of applying alignment anchor indent to the target block that starts new line.
protected abstract IndentData	calculateAlignmentAnchorIndent(BlockAlignmentProcessor.Context context) Asks to calculate indent used for the anchor block of the alignment used by the target block.
protected abstract int	getAlignmentIndentDiff(IndentData alignmentAnchorIndent, BlockAlignmentProcessor.Context context) Calculates the difference between alignment anchor indent and current target block indent.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBlockAlignmentProcessor

public AbstractBlockAlignmentProcessor()

Method Detail

applyAlignment

public BlockAlignmentProcessor.Result applyAlignment(BlockAlignmentProcessor.Context context)

Description copied from interface: BlockAlignmentProcessor

Asks current processor to perform alignment processing for the parameters encapsulated at the given context.

Specified by:

applyAlignment in interface BlockAlignmentProcessor

Parameters:

context - target parameters holder

Returns:

processing result

calculateAlignmentAnchorIndent

protected abstract IndentData calculateAlignmentAnchorIndent(BlockAlignmentProcessor.Context context)

Asks to calculate indent used for the anchor block of the alignment used by the target block.

Parameters:

context - current processing context

Returns:

indent to use for the white space of the given block

applyIndentToTheFirstBlockOnLine

protected abstract boolean applyIndentToTheFirstBlockOnLine(IndentData alignmentAnchorIndent,
                                                            BlockAlignmentProcessor.Context context)

Encapsulates logic of applying alignment anchor indent to the target block that starts new line.

Parameters:

alignmentAnchorIndent - alignment anchor indent

context - current processing context

Returns:

true if desired alignment indent is applied to the current block; false otherwise

getAlignmentIndentDiff

protected abstract int getAlignmentIndentDiff(IndentData alignmentAnchorIndent,
                                              BlockAlignmentProcessor.Context context)

Calculates the difference between alignment anchor indent and current target block indent.

Parameters:

alignmentAnchorIndent - alignment anchor indent

context - current processing context

Returns:

alignment anchor indent minus current target block indent