Package com.intellij.formatting.templateLanguages

Class TemplateLanguageBlock

java.lang.Object

com.intellij.psi.formatter.common.AbstractBlock

com.intellij.formatting.templateLanguages.TemplateLanguageBlock

All Implemented Interfaces:

ASTBlock, Block, BlockWithParent, ExtraRangesProvider

public abstract class TemplateLanguageBlock
extends AbstractBlock
implements BlockWithParent

Field Summary

Fields inherited from class com.intellij.psi.formatter.common.AbstractBlock

EMPTY, myAlignment, myNode, myWrap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TemplateLanguageBlock(ASTNode node, Wrap wrap, Alignment alignment, TemplateLanguageBlockFactory blockFactory, CodeStyleSettings settings, java.util.List<DataLanguageBlockWrapper> foreignChildren)
protected	TemplateLanguageBlock(TemplateLanguageBlockFactory blockFactory, CodeStyleSettings settings, ASTNode node, java.util.List<DataLanguageBlockWrapper> foreignChildren)

Method Summary

Modifier and Type	Method and Description
protected java.util.List<Block>	buildChildren()
protected Alignment	createChildAlignment(ASTNode child)
protected Wrap	createChildWrap(ASTNode child)
java.util.List<DataLanguageBlockWrapper>	getForeignChildren()
Spacing	getLeftNeighborSpacing(Block leftNeighbor, DataLanguageBlockWrapper parent, int thisBlockIndex) Invoked when the current base language block is located inside a template data language block to determine the spacing before the current block.
BlockWithParent	getParent()
Spacing	getRightNeighborSpacing(Block rightNeighbor, DataLanguageBlockWrapper parent, int thisBlockIndex) Invoked when the current base language block is located inside a template data language block to determine the spacing after the current block.
CodeStyleSettings	getSettings()
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.
protected abstract IElementType	getTemplateTextElementType()
boolean	isLeaf() Returns true if the specified block may not contain child blocks.
boolean	isRequiredRange(TextRange range) Checks if DataLanguageBlockFragmentWrapper must be created for the given text range.
void	setParent(BlockWithParent newParent)
protected boolean	shouldBuildBlockFor(ASTNode childNode)
Wrap	substituteTemplateChildWrap(DataLanguageBlockWrapper child, Wrap childWrap)

Methods inherited from class com.intellij.psi.formatter.common.AbstractBlock

getAlignment, getChildAttributes, getChildIndent, getExtraRangesToFormat, getIndent, getNode, getSubBlocks, getTextRange, getWrap, isBuildIndentsOnly, isIncomplete, setBuildIndentsOnly, 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

Constructor Detail

TemplateLanguageBlock

protected TemplateLanguageBlock(TemplateLanguageBlockFactory blockFactory,
                                CodeStyleSettings settings,
                                ASTNode node,
                                java.util.List<DataLanguageBlockWrapper> foreignChildren)

TemplateLanguageBlock

protected TemplateLanguageBlock(ASTNode node,
                                Wrap wrap,
                                Alignment alignment,
                                TemplateLanguageBlockFactory blockFactory,
                                CodeStyleSettings settings,
                                java.util.List<DataLanguageBlockWrapper> foreignChildren)

Method Detail

buildChildren

protected java.util.List<Block> buildChildren()

Specified by:

buildChildren in class AbstractBlock

shouldBuildBlockFor

protected boolean shouldBuildBlockFor(ASTNode childNode)

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()

getRightNeighborSpacing

public Spacing getRightNeighborSpacing(Block rightNeighbor,
                                       DataLanguageBlockWrapper parent,
                                       int thisBlockIndex)

Invoked when the current base language block is located inside a template data language block to determine the spacing after the current block.

Parameters:

rightNeighbor - the block to the right of the current one

parent - the parent block

thisBlockIndex - the index of the current block in the parent block sub-blocks

Returns:

the spacing between the current block and its right neighbor

getLeftNeighborSpacing

public Spacing getLeftNeighborSpacing(Block leftNeighbor,
                                      DataLanguageBlockWrapper parent,
                                      int thisBlockIndex)

Invoked when the current base language block is located inside a template data language block to determine the spacing before the current block.

Parameters:

leftNeighbor - the block to the left of the current one, or null if the current block is first child

parent - the parent block

thisBlockIndex - the index of the current block in the parent block sub-blocks

Returns:

the spacing between the current block and its left neighbor

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.

getTemplateTextElementType

protected abstract IElementType getTemplateTextElementType()

getParent

public BlockWithParent getParent()

Specified by:

getParent in interface BlockWithParent

setParent

public void setParent(BlockWithParent newParent)

Specified by:

setParent in interface BlockWithParent

isRequiredRange

public boolean isRequiredRange(TextRange range)

Checks if DataLanguageBlockFragmentWrapper must be created for the given text range.

Parameters:

range - The range to check.

Returns:

True by default.

createChildWrap

protected Wrap createChildWrap(ASTNode child)

createChildAlignment

protected Alignment createChildAlignment(ASTNode child)

getSettings

public CodeStyleSettings getSettings()

getForeignChildren

public java.util.List<DataLanguageBlockWrapper> getForeignChildren()

substituteTemplateChildWrap

public Wrap substituteTemplateChildWrap(DataLanguageBlockWrapper child,
                                        Wrap childWrap)