Package com.intellij.psi.formatter.java

Class SimpleJavaBlock

java.lang.Object

com.intellij.psi.formatter.common.AbstractBlock

com.intellij.psi.formatter.java.AbstractJavaBlock

com.intellij.psi.formatter.java.SimpleJavaBlock

All Implemented Interfaces:

ASTBlock, Block, ExtraRangesProvider, JavaBlock, ReservedWrapsProvider

Direct Known Subclasses:

PartialWhitespaceBlock

public class SimpleJavaBlock
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
SimpleJavaBlock(ASTNode node, Wrap wrap, AlignmentStrategy 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.
Wrap	getReservedWrap(IElementType elementType) Note: this method is considered to be a legacy heritage and is assumed to be removed as soon as formatting processing is refactored
TextRange	getTextRange() Returns the text range covered by the block.
void	setReservedWrap(Wrap reservedWrap, IElementType operationType) Defines contract for associating operation type and particular wrap instance.
void	setStartOffset(int startOffset)

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, getSettings, getSpacing, getStrategyProvider, getTreeNode, getUsedAlignment, isAfter, isLeaf, isRBrace, isStatement, newJavaBlock, newJavaBlock, processChild, processChild, processChild, setParentBlock

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

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

SimpleJavaBlock

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

Method Detail

buildChildren

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

Specified by:

buildChildren in class AbstractBlock

getTextRange

public TextRange getTextRange()

Description copied from interface: Block

Returns the text range covered by the block.

Specified by:

getTextRange in interface Block

Overrides:

getTextRange in class AbstractBlock

Returns:

the text range.

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.

getReservedWrap

public Wrap getReservedWrap(IElementType elementType)

Description copied from class: AbstractJavaBlock

Note: this method is considered to be a legacy heritage and is assumed to be removed as soon as formatting processing is refactored

Specified by:

getReservedWrap in interface ReservedWrapsProvider

Overrides:

getReservedWrap in class AbstractJavaBlock

Parameters:

elementType - target element type

Returns:

null all the time

setReservedWrap

public void setReservedWrap(Wrap reservedWrap,
                            IElementType operationType)

Description copied from class: AbstractJavaBlock

Defines contract for associating operation type and particular wrap instance. I.e. given wrap object may be returned from subsequent AbstractJavaBlock.getReservedWrap(IElementType) call if given operation type is used as an argument there.

Default implementation (AbstractJavaBlock.setReservedWrap(Wrap, IElementType)) does nothing.

Note: this method is considered to be a legacy heritage and is assumed to be removed as soon as formatting processing is refactored

Overrides:

setReservedWrap in class AbstractJavaBlock

Parameters:

reservedWrap - reserved wrap instance

operationType - target operation type to associate with the given wrap instance

setStartOffset

public void setStartOffset(int startOffset)