Package com.intellij.formatting.templateLanguages

Class DataLanguageBlockWrapper

java.lang.Object

com.intellij.formatting.templateLanguages.DataLanguageBlockWrapper

All Implemented Interfaces:

ASTBlock, Block, BlockEx, BlockWithParent

public class DataLanguageBlockWrapper
extends java.lang.Object
implements ASTBlock, BlockEx, BlockWithParent

Method Summary

Modifier and Type	Method and Description
static DataLanguageBlockWrapper	create(Block original, Indent indent)
Alignment	getAlignment() Returns an alignment object indicating how this block is aligned with other blocks.
ChildAttributes	getChildAttributes(int newChildIndex) Returns the alignment and indent attributes which are applied to a new block inserted at the specified position in the list of children of this block.
Indent	getIndent() Returns an indent object indicating how this block is indented relative to its parent block.
Language	getLanguage()
ASTNode	getNode()
Block	getOriginal()
BlockWithParent	getParent()
Spacing	getRightHandSpacing(DataLanguageBlockWrapper rightHandWrapper)
Spacing	getSpacing(Block child1, Block child2) Returns a spacing object indicating what spaces and/or line breaks are added between two specified children of this block.
java.util.List<Block>	getSubBlocks() Returns the list of child blocks for the specified block.
TextRange	getTextRange() Returns the text range covered by the block.
Wrap	getWrap() Returns a wrap object indicating the conditions under which a line break is inserted before this block when formatting, if the block extends beyond the right margin.
boolean	isIncomplete() Checks if the current block is incomplete (contains elements that the user will probably type but has not yet typed).
boolean	isLeaf() Returns true if the specified block may not contain child blocks.
void	setParent(BlockWithParent parent)
void	setRightHandSpacing(DataLanguageBlockWrapper rightHandWrapper, Spacing spacing)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.formatting.ASTBlock

getElementType, getNode, getPsiElement

Methods inherited from interface com.intellij.formatting.Block

getDebugName

Method Detail

getTextRange

public TextRange getTextRange()

Description copied from interface: Block

Returns the text range covered by the block.

Specified by:

getTextRange in interface Block

Returns:

the text range.

getSubBlocks

public java.util.List<Block> getSubBlocks()

Description copied from interface: Block

Returns the list of child blocks for the specified block. Important: The same list of blocks must be returned when getSubBlocks() is repeatedly called on a particular Block instance. Even more Important: If immutable list is returned (e.g. Collections.singletonList(xxx), you must mark this Block class with com.intellij.formatting.ReadOnlyBlockContainer marker interface.

Specified by:

getSubBlocks in interface Block

Returns:

the child block list.

See Also:

Block.isLeaf()

getLanguage

public Language getLanguage()

Specified by:

getLanguage in interface BlockEx

getWrap

public Wrap getWrap()

Description copied from interface: Block

Returns a wrap object indicating the conditions under which a line break is inserted before this block when formatting, if the block extends beyond the right margin.

Specified by:

getWrap in interface Block

Returns:

the wrap object, or null if the line break is never inserted.

See Also:

Wrap.createWrap(WrapType, boolean), Wrap.createChildWrap(Wrap, WrapType, boolean)

getChildAttributes

public ChildAttributes getChildAttributes(int newChildIndex)

Description copied from interface: Block

Returns the alignment and indent attributes which are applied to a new block inserted at the specified position in the list of children of this block. Used for performing automatic indent when Enter is pressed.

Specified by:

getChildAttributes in interface Block

Parameters:

newChildIndex - the index where a new child is inserted.

Returns:

the object containing the indent and alignment settings for the new child.

getIndent

public Indent getIndent()

Description copied from interface: Block

Returns an indent object indicating how this block is indented relative to its parent block.

Specified by:

getIndent in interface Block

Returns:

the indent object, or null if the default indent ("continuation without first") should be used.

See Also:

Indent.getContinuationWithoutFirstIndent()

getAlignment

public Alignment getAlignment()

Description copied from interface: Block

Returns an alignment object indicating how this block is aligned with other blocks. Blocks which return the same alignment object instance from the getAlignment method are aligned with each other.

Specified by:

getAlignment in interface Block

Returns:

the alignment object instance, or null if no alignment is required for the block.

getSpacing

public Spacing getSpacing(Block child1,
                          Block child2)

Description copied from interface: Block

Returns a spacing object indicating what spaces and/or line breaks are added between two specified children of this block.

Specified by:

getSpacing in interface Block

Parameters:

child1 - the first child for which spacing is requested; null if given 'child2' block is the first document block

child2 - the second child for which spacing is requested.

Returns:

the spacing instance, or null if no special spacing is required. If null is returned, the formatter does not insert or delete spaces between the child blocks, but may insert a line break if the line wraps at the position between the child blocks.

See Also:

Spacing.createSpacing(int, int, int, boolean, int), Spacing.getReadOnlySpacing()

isIncomplete

public boolean isIncomplete()

Description copied from interface: Block

Checks if the current block is incomplete (contains elements that the user will probably type but has not yet typed). For example, a parameter list is incomplete if it does not have the trailing parenthesis, and a statement is incomplete if it does not have the trailing semicolon. Used to determine the block for which Block.getChildAttributes(int) is called when Enter is pressed: if the block immediately before the cursor is incomplete, the method is called for that block; otherwise, the method is called for the parent of that block.

Specified by:

isIncomplete in interface Block

Returns:

true if the block is incomplete, false otherwise.

isLeaf

public boolean isLeaf()

Description copied from interface: Block

Returns true if the specified block may not contain child blocks. Used as an optimization to avoid building the complete formatting model through calls to Block.getSubBlocks().

Specified by:

isLeaf in interface Block

Returns:

true if the block is a leaf block and may not contain child blocks, false otherwise.

getOriginal

public Block getOriginal()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

create

public static DataLanguageBlockWrapper create(Block original,
                                              Indent indent)

getNode

public ASTNode getNode()

Specified by:

getNode in interface ASTBlock

getParent

public BlockWithParent getParent()

Specified by:

getParent in interface BlockWithParent

setParent

public void setParent(BlockWithParent parent)

Specified by:

setParent in interface BlockWithParent

setRightHandSpacing

public void setRightHandSpacing(DataLanguageBlockWrapper rightHandWrapper,
                                Spacing spacing)

getRightHandSpacing

public Spacing getRightHandSpacing(DataLanguageBlockWrapper rightHandWrapper)