Package com.intellij.formatting

Interface FormattingModelWithShiftIndentInsideDocumentRange

All Superinterfaces:

FormattingModel, FormattingModelEx

public interface FormattingModelWithShiftIndentInsideDocumentRange
extends FormattingModelEx

Defines the psi-based formatting model that is responsible for multiline AST nodes indentation at the stage of document-based formatting. The shiftIndentInsideDocumentRange method is called in the model, instead of standard FormattingModel.shiftIndentInsideRange(ASTNode, TextRange, int) procedure.

Method Summary

Modifier and Type	Method and Description
java.lang.String	adjustWhiteSpaceInsideDocument(ASTNode node, java.lang.String whiteSpace) Adjusts indentation space before the multiline AST node.
TextRange	shiftIndentInsideDocumentRange(Document document, ASTNode node, TextRange range, int indent) Indents every line except for the first in the specified text range representing a multiline block by the specified amount.

Methods inherited from interface com.intellij.formatting.FormattingModelEx

replaceWhiteSpace

Methods inherited from interface com.intellij.formatting.FormattingModel

commitChanges, getDocumentModel, getRootBlock, replaceWhiteSpace, shiftIndentInsideRange

Method Detail

shiftIndentInsideDocumentRange

TextRange shiftIndentInsideDocumentRange(Document document,
                                         ASTNode node,
                                         TextRange range,
                                         int indent)

Indents every line except for the first in the specified text range representing a multiline block by the specified amount.

Parameters:

document - the document for modification.

node - the owner of the text range, if defined.

range - the text range to indent.

indent - the amount by which every line should be indented.

Returns:

the text range covering the block with added indents or null for call of default procedure.

adjustWhiteSpaceInsideDocument

java.lang.String adjustWhiteSpaceInsideDocument(ASTNode node,
                                                java.lang.String whiteSpace)

Adjusts indentation space before the multiline AST node.

Parameters:

node - the multiline node.

whiteSpace - the leading space for the node after formatting procedure.

Returns:

the adjusted indent (or whiteSpace if no correction needs).