Package com.intellij.psi.formatter.java

Class CommentWithInjectionBlock

java.lang.Object

com.intellij.psi.formatter.common.AbstractBlock

com.intellij.psi.formatter.java.AbstractJavaBlock

com.intellij.psi.formatter.java.CommentWithInjectionBlock

All Implemented Interfaces:

ASTBlock, Block, ExtraRangesProvider, JavaBlock, ReservedWrapsProvider

public class CommentWithInjectionBlock
extends AbstractJavaBlock

Field Summary

Fields inherited from class com.intellij.psi.formatter.java.AbstractJavaBlock

myAlignmentStrategy, myChildAlignment, myChildIndent, myIndentSettings, myJavaSettings, myReservedAlignment, myReservedAlignment2, mySettings, myUseChildAttributes

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

EMPTY, myAlignment, myNode, myWrap

Constructor Summary

Constructors

Constructor and Description
CommentWithInjectionBlock(ASTNode node, Wrap wrap, Alignment alignment, Indent indent, CommonCodeStyleSettings settings, JavaCodeStyleSettings javaSettings, FormattingMode formattingMode)

Method Summary

Modifier and Type	Method and Description
protected java.util.List<Block>	buildChildren()
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.
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.
boolean	isLeaf() Returns true if the specified block may not contain child blocks.

Methods inherited from class com.intellij.psi.formatter.java.AbstractJavaBlock

arrangeChildWrap, chooseAlignment, composeCodeBlock, createAlignment, createAlignment, createChildAlignment, createChildWrap, createCodeBlockBlock, createJavaBlock, createJavaBlock, createNormalIndent, createNormalIndent, getChildIndent, getCodeBlockChildExternalIndent, getCodeBlockExternalIndent, getCodeBlockInternalIndent, getFirstTreeNode, getFormattingMode, getIndent, getParentBlock, getReservedWrap, getSettings, getStrategyProvider, getTreeNode, getUsedAlignment, isAfter, isRBrace, isStatement, newJavaBlock, newJavaBlock, processChild, processChild, processChild, setParentBlock, setReservedWrap

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

getAlignment, getExtraRangesToFormat, 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

CommentWithInjectionBlock

public CommentWithInjectionBlock(ASTNode node,
                                 Wrap wrap,
                                 Alignment alignment,
                                 Indent indent,
                                 CommonCodeStyleSettings settings,
                                 JavaCodeStyleSettings javaSettings,
                                 FormattingMode formattingMode)

Method Detail

buildChildren

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

Specified by:

buildChildren in class AbstractBlock

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

Overrides:

isLeaf in class AbstractJavaBlock

Returns:

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

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

Overrides:

getChildAttributes in class AbstractJavaBlock

Parameters:

newChildIndex - the index where a new child is inserted.

Returns:

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

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

Overrides:

getSpacing in class AbstractJavaBlock

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