AbstractBlockWrapper (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.formatting.AbstractBlockWrapper

Direct Known Subclasses:: CompositeBlockWrapper, LeafBlockWrapper

public abstract class AbstractBlockWrapper
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`myEnd`
`protected int`	`myFlags`
`protected IndentInfo`	`myIndentFromParent`
`protected CompositeBlockWrapper`	`myParent`
`protected int`	`myStart`

Constructor Summary

Constructors
Constructor and Description
`AbstractBlockWrapper(Block block, WhiteSpace whiteSpaceBefore, CompositeBlockWrapper parent, TextRange textRange)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`arrangeParentTextRange()` Applies start offset of the current block wrapper to the parent block wrapper if the one is defined.
`protected void`	`arrangeStartOffset(int startOffset)` Applies given start offset to the current block wrapper and recursively calls this method on parent block wrapper if it starts at the same place as the current one.
`IndentData`	`calculateChildOffset(CommonCodeStyleSettings.IndentOptions indentOption, ChildAttributes childAttributes, int index)`
`void`	`dispose()`
`protected AbstractBlockWrapper`	`findFirstIndentedParent()` Tries to find first parent block of the current block that starts before the current block and which `white space` contains line feeds.
`AlignmentImpl`	`getAlignment()`
`AlignmentImpl`	`getAlignmentAtStartOffset()` Allows to retrieve alignment applied to any block that conforms to the following conditions: that block is current block or its ancestor (direct or indirect parent); that block starts at the same offset as the current one;
`IndentData`	`getChildOffset(AbstractBlockWrapper child, CommonCodeStyleSettings.IndentOptions options, int targetBlockStartOffset)`
`int`	`getEndOffset()`
`IndentImpl`	`getIndent()`
`Language`	`getLanguage()` There is a possible case that particular block's language differs from the language implied by the file type.
`int`	`getLength()`
`ASTNode`	`getNode()` Returns the AST node corresponding to the block, if known.
`abstract IndentData`	`getNumberOfSymbolsBeforeBlock()` Allows to retrieve object that encapsulates information about number of symbols before the current block starting from the line start.
`WrapImpl`	`getOwnWrap()`
`CompositeBlockWrapper`	`getParent()`
`protected abstract LeafBlockWrapper`	`getPreviousBlock()`
`int`	`getStartOffset()`
`WhiteSpace`	`getWhiteSpace()` Returns the whitespace preceding the block.
`WrapImpl`	`getWrap()`
`java.util.ArrayList<WrapImpl>`	`getWraps()` Returns the list of wraps for this block and its parent blocks that start at the same offset.
`protected abstract 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`	`isIncomplete()`
`void`	`reset()`
`protected void`	`setCanUseFirstChildIndentAsBlockIndent(boolean newValue)`
`void`	`setIndent(IndentImpl indent)`
`void`	`setIndentFromParent(IndentInfo indentFromParent)` Applies given indent value to '`indentFromParent'` property of the current wrapped block.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - myParent
```
protected CompositeBlockWrapper myParent
```
  - myStart
```
protected int myStart
```
  - myEnd
```
protected int myEnd
```
  - myFlags
```
protected int myFlags
```
  - myIndentFromParent
```
protected IndentInfo myIndentFromParent
```
- Constructor Detail
  - AbstractBlockWrapper
```
public AbstractBlockWrapper(Block block,
                            WhiteSpace whiteSpaceBefore,
                            CompositeBlockWrapper parent,
                            TextRange textRange)
```
- Method Detail
  - getWhiteSpace
```
public WhiteSpace getWhiteSpace()
```
    Returns the whitespace preceding the block.
    
    Returns:
    
    the whitespace preceding the block
  - getNode
```
public ASTNode getNode()
```
    Returns the AST node corresponding to the block, if known.
    
    Returns:
    
    the AST node or null
  - getWraps
```
public java.util.ArrayList<WrapImpl> getWraps()
```
    Returns the list of wraps for this block and its parent blocks that start at the same offset. The returned list is ordered from top to bottom (higher-level wraps go first). Stops if the wrap for a block is marked as "ignore parent wraps".
    
    Returns:
    
    the list of wraps.
  - getStartOffset
```
public int getStartOffset()
```
  - getEndOffset
```
public int getEndOffset()
```
  - getLength
```
public int getLength()
```
  - getLanguage
```
public Language getLanguage()
```
    There is a possible case that particular block's language differs from the language implied by the file type. We need to distinguish such a situation because, for example in case of indent calculation (code style settings for different languages may have different indent values).
    This method allows to retrieve the language associated with the current block (if provided).
    
    Returns:
    
    current block's language (if provided)
  - arrangeStartOffset
```
protected void arrangeStartOffset(int startOffset)
```
    Applies given start offset to the current block wrapper and recursively calls this method on parent block wrapper if it starts at the same place as the current one.
    
    Parameters:
    
    startOffset - new start offset value to apply
  - getIndent
```
public IndentImpl getIndent()
```
  - getParent
```
public CompositeBlockWrapper getParent()
```
  - getWrap
```
public WrapImpl getWrap()
```
  - getOwnWrap
```
public WrapImpl getOwnWrap()
```
    Returns:
    
    wrap object configured for the current block wrapper if any; null otherwise
  - reset
```
public void reset()
```
  - getChildOffset
```
public IndentData getChildOffset(AbstractBlockWrapper child,
                                 CommonCodeStyleSettings.IndentOptions options,
                                 int targetBlockStartOffset)
```
  - indentAlreadyUsedBefore
```
protected abstract 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.
    
    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 abstract IndentData getNumberOfSymbolsBeforeBlock()
```
    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.
    
    Returns:
    
    object that encapsulates information about number of symbols before the current block
  - getPreviousBlock
```
protected abstract LeafBlockWrapper getPreviousBlock()
```
    Returns:
    
    previous block for the current block if any; null otherwise
  - setCanUseFirstChildIndentAsBlockIndent
```
protected final void setCanUseFirstChildIndentAsBlockIndent(boolean newValue)
```
  - arrangeParentTextRange
```
public void arrangeParentTextRange()
```
    Applies start offset of the current block wrapper to the parent block wrapper if the one is defined.
  - calculateChildOffset
```
public IndentData calculateChildOffset(CommonCodeStyleSettings.IndentOptions indentOption,
                                       ChildAttributes childAttributes,
                                       int index)
```
  - getAlignmentAtStartOffset
```
public AlignmentImpl getAlignmentAtStartOffset()
```
    Allows to retrieve alignment applied to any block that conforms to the following conditions:
    - that block is current block or its ancestor (direct or indirect parent);
    - that block starts at the same offset as the current one;
    Returns:
    
    alignment of the current block or it's ancestor that starts at the same offset as the current if any; null otherwise
  - setIndentFromParent
```
public void setIndentFromParent(IndentInfo indentFromParent)
```
    Applies given indent value to 'indentFromParent' property of the current wrapped block.
    Given value is also applied to 'indentFromParent' properties of all parents of the current wrapped block if the value is defined (not null).
    This property is used later during LeafBlockWrapper.calculateOffset(CommonCodeStyleSettings.IndentOptions) leaf block offset calculation}.
    
    Parameters:
    
    indentFromParent - indent value to apply
  - findFirstIndentedParent
```
protected AbstractBlockWrapper findFirstIndentedParent()
```
    Tries to find first parent block of the current block that starts before the current block and which white space contains line feeds.
    
    Returns:
    
    first parent block that starts before the current block and which white space contains line feeds if any; null otherwise
  - setIndent
```
public void setIndent(IndentImpl indent)
```
  - getAlignment
```
public AlignmentImpl getAlignment()
```
  - isIncomplete
```
public boolean isIncomplete()
```
  - dispose
```
public void dispose()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AbstractBlockWrapper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

myParent

myStart

myEnd

myFlags

myIndentFromParent

Constructor Detail

AbstractBlockWrapper

Method Detail

getWhiteSpace

getNode

getWraps

getStartOffset

getEndOffset

getLength

getLanguage

arrangeStartOffset

getIndent

getParent

getWrap

getOwnWrap

reset

getChildOffset

indentAlreadyUsedBefore

getNumberOfSymbolsBeforeBlock

getPreviousBlock

setCanUseFirstChildIndentAsBlockIndent

arrangeParentTextRange

calculateChildOffset

getAlignmentAtStartOffset

setIndentFromParent

findFirstIndentedParent

setIndent

getAlignment

isIncomplete

dispose

toString