Package com.intellij.formatting

Interface FormattingModelEx

All Superinterfaces:

FormattingModel

All Known Subinterfaces:

FormattingModelWithShiftIndentInsideDocumentRange

All Known Implementing Classes:

DelegatingFormattingModel, DocumentBasedFormattingModel, PsiBasedFormatterModelWithShiftIndentInside, PsiBasedFormattingModel, XmlFormattingModel

public interface FormattingModelEx
extends FormattingModel

Method Summary

Modifier and Type	Method and Description
TextRange	replaceWhiteSpace(TextRange textRange, ASTNode nodeAfter, java.lang.String whiteSpace) Replaces the contents of the specified text range in the document with the specified text string consisting of whitespace characters.

Methods inherited from interface com.intellij.formatting.FormattingModel

commitChanges, getDocumentModel, getRootBlock, replaceWhiteSpace, shiftIndentInsideRange

Method Detail

replaceWhiteSpace

TextRange replaceWhiteSpace(TextRange textRange,
                            ASTNode nodeAfter,
                            java.lang.String whiteSpace)

Replaces the contents of the specified text range in the document with the specified text string consisting of whitespace characters. If necessary, other characters may be inserted in addition to the passed whitespace (for example, \ characters for breaking lines in languages like Python).

Parameters:

textRange - the text range to replace with whitespace.

nodeAfter - the AST node following the whitespace, if known

whiteSpace - the whitespace to replace with.

Returns:

new white space text range