Package com.intellij.formatting

Class LeafBlockWrapper

java.lang.Object

com.intellij.formatting.AbstractBlockWrapper

com.intellij.formatting.LeafBlockWrapper

public class LeafBlockWrapper
extends AbstractBlockWrapper

Field Summary

Fields inherited from class com.intellij.formatting.AbstractBlockWrapper

myEnd, myFlags, myIndentFromParent, myParent, myStart

Constructor Summary

Constructors

Constructor and Description

LeafBlockWrapper(Block block, CompositeBlockWrapper parent, WhiteSpace whiteSpaceBefore, FormattingDocumentModel model, CommonCodeStyleSettings.IndentOptions options, LeafBlockWrapper previousTokenBlock, boolean isReadOnly) Shortcut for calling LeafBlockWrapper(Block, CompositeBlockWrapper, WhiteSpace, FormattingDocumentModel, CommonCodeStyleSettings.IndentOptions, LeafBlockWrapper, boolean, TextRange) with text range associated with the given block.

Method Summary

Modifier and Type	Method and Description
IndentData	calculateOffset(CommonCodeStyleSettings.IndentOptions options)
boolean	contains(int offset)
boolean	containsLineFeeds()
void	dispose()
LeafBlockWrapper	getNextBlock()
IndentData	getNumberOfSymbolsBeforeBlock() Allows to retrieve object that encapsulates information about number of symbols before the current block starting from the line start.
LeafBlockWrapper	getPreviousBlock()
SpacingImpl	getSpaceProperty()
int	getSymbolsAtTheLastLine()
TextRange	getTextRange()
protected boolean	indentAlreadyUsedBefore(AbstractBlockWrapper child) Allows to answer if current wrapped block has a child block that is located before given block and has line feed.
boolean	isEndOfCodeBlock()
boolean	isLeaf()
void	setNextBlock(LeafBlockWrapper nextBlock)
void	setSpaceProperty(SpacingImpl currentSpaceProperty)

Methods inherited from class com.intellij.formatting.AbstractBlockWrapper

arrangeParentTextRange, arrangeStartOffset, calculateChildOffset, findFirstIndentedParent, getAlignment, getAlignmentAtStartOffset, getChildOffset, getEndOffset, getIndent, getLanguage, getLength, getNode, getOwnWrap, getParent, getStartOffset, getWhiteSpace, getWrap, getWraps, isIncomplete, reset, setCanUseFirstChildIndentAsBlockIndent, setIndent, setIndentFromParent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LeafBlockWrapper

public LeafBlockWrapper(Block block,
                        CompositeBlockWrapper parent,
                        WhiteSpace whiteSpaceBefore,
                        FormattingDocumentModel model,
                        CommonCodeStyleSettings.IndentOptions options,
                        LeafBlockWrapper previousTokenBlock,
                        boolean isReadOnly)

Shortcut for calling LeafBlockWrapper(Block, CompositeBlockWrapper, WhiteSpace, FormattingDocumentModel, CommonCodeStyleSettings.IndentOptions, LeafBlockWrapper, boolean, TextRange) with text range associated with the given block.

Parameters:

block - block to wrap

parent - wrapped parent block

whiteSpaceBefore - white space before the target block to wrap

model - formatting model to use during current wrapper initialization

options - code formatting options

previousTokenBlock - previous token block

isReadOnly - flag that indicates if target block is read-only

Method Detail

containsLineFeeds

public final boolean containsLineFeeds()

getSymbolsAtTheLastLine

public int getSymbolsAtTheLastLine()

getPreviousBlock

public LeafBlockWrapper getPreviousBlock()

Specified by:

getPreviousBlock in class AbstractBlockWrapper

Returns:

previous block for the current block if any; null otherwise

getNextBlock

public LeafBlockWrapper getNextBlock()

setNextBlock

public void setNextBlock(LeafBlockWrapper nextBlock)

indentAlreadyUsedBefore

protected boolean indentAlreadyUsedBefore(AbstractBlockWrapper child)

Description copied from class: AbstractBlockWrapper

Allows to answer if current wrapped block has a child block that is located before given block and has line feed.

Specified by:

indentAlreadyUsedBefore in class AbstractBlockWrapper

Parameters:

child - target child block to process

Returns:

true if current block has a child that is located before the given block and contains line feed; false otherwise

getNumberOfSymbolsBeforeBlock

public IndentData getNumberOfSymbolsBeforeBlock()

Description copied from class: AbstractBlockWrapper

Allows to retrieve object that encapsulates information about number of symbols before the current block starting from the line start. I.e. all symbols (either white space or not) between start of the line where current block begins and the block itself are count and returned.

Specified by:

getNumberOfSymbolsBeforeBlock in class AbstractBlockWrapper

Returns:

object that encapsulates information about number of symbols before the current block

dispose

public void dispose()

Overrides:

dispose in class AbstractBlockWrapper

getSpaceProperty

public SpacingImpl getSpaceProperty()

Returns:

spacing between current block and its left sibling

calculateOffset

public IndentData calculateOffset(CommonCodeStyleSettings.IndentOptions options)

setSpaceProperty

public void setSpaceProperty(SpacingImpl currentSpaceProperty)

isLeaf

public final boolean isLeaf()

contains

public boolean contains(int offset)

getTextRange

public TextRange getTextRange()

isEndOfCodeBlock

public boolean isEndOfCodeBlock()