Package com.intellij.psi.formatter

Class DocumentBasedFormattingModel

java.lang.Object

com.intellij.psi.formatter.DocumentBasedFormattingModel

All Implemented Interfaces:

FormattingModel, FormattingModelEx

public class DocumentBasedFormattingModel
extends java.lang.Object
implements FormattingModelEx

Constructor Summary

Constructors

Constructor and Description
DocumentBasedFormattingModel(Block rootBlock, CodeStyleSettings settings, PsiFile file)
DocumentBasedFormattingModel(Block rootBlock, Document document, Project project, CodeStyleSettings settings, FileType fileType, PsiFile file) Deprecated. use other CTORs
DocumentBasedFormattingModel(Block rootBlock, Project project, CodeStyleSettings settings, FileType fileType, PsiFile file)
DocumentBasedFormattingModel(FormattingModel originalModel, Document document, Project project, CodeStyleSettings settings, FileType fileType, PsiFile file)

Method Summary

Modifier and Type	Method and Description
void	commitChanges() Commits the changes made by the formatter to the document.
Document	getDocument()
FormattingDocumentModel	getDocumentModel() Returns the formatting document model, which allows the formatter to access information about the document containing the text to be formatted.
PsiFile	getFile()
Project	getProject()
Block	getRootBlock() Returns the root block of the formatting model.
static java.lang.String	mergeWsWithCdataMarker(java.lang.String whiteSpace, java.lang.String s, int cdataPos)
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.
TextRange	replaceWhiteSpace(TextRange textRange, java.lang.String whiteSpace) Replaces the contents of the specified text range in the document with the specified text string consisting of whitespace characters.
TextRange	shiftIndentInsideRange(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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentBasedFormattingModel

@Deprecated
public DocumentBasedFormattingModel(Block rootBlock,
                                    Document document,
                                    Project project,
                                    CodeStyleSettings settings,
                                    FileType fileType,
                                    PsiFile file)

Deprecated. use other CTORs

DocumentBasedFormattingModel

public DocumentBasedFormattingModel(Block rootBlock,
                                    CodeStyleSettings settings,
                                    PsiFile file)

DocumentBasedFormattingModel

public DocumentBasedFormattingModel(Block rootBlock,
                                    Project project,
                                    CodeStyleSettings settings,
                                    FileType fileType,
                                    PsiFile file)

DocumentBasedFormattingModel

public DocumentBasedFormattingModel(FormattingModel originalModel,
                                    Document document,
                                    Project project,
                                    CodeStyleSettings settings,
                                    FileType fileType,
                                    PsiFile file)

Method Detail

getRootBlock

public Block getRootBlock()

Description copied from interface: FormattingModel

Returns the root block of the formatting model. The root block corresponds to the top-level element passed to FormattingModelBuilder.createModel(com.intellij.psi.PsiElement, com.intellij.psi.codeStyle.CodeStyleSettings).

Specified by:

getRootBlock in interface FormattingModel

Returns:

the root block of the model.

getDocumentModel

public FormattingDocumentModel getDocumentModel()

Description copied from interface: FormattingModel

Returns the formatting document model, which allows the formatter to access information about the document containing the text to be formatted.

Specified by:

getDocumentModel in interface FormattingModel

Returns:

the formatting document model.

replaceWhiteSpace

public TextRange replaceWhiteSpace(TextRange textRange,
                                   java.lang.String whiteSpace)

Description copied from interface: FormattingModel

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

Specified by:

replaceWhiteSpace in interface FormattingModel

Parameters:

textRange - the text range to replace with whitespace.

whiteSpace - the whitespace to replace with.

Returns:

new white space text range

replaceWhiteSpace

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

Description copied from interface: FormattingModelEx

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

Specified by:

replaceWhiteSpace in interface FormattingModelEx

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

shiftIndentInsideRange

public TextRange shiftIndentInsideRange(ASTNode node,
                                        TextRange range,
                                        int indent)

Description copied from interface: FormattingModel

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

Specified by:

shiftIndentInsideRange in interface FormattingModel

Parameters:

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.

commitChanges

public void commitChanges()

Description copied from interface: FormattingModel

Commits the changes made by the formatter to the document. Called after the formatter has finished making all changes in a formatting operation.

Specified by:

commitChanges in interface FormattingModel

getDocument

public Document getDocument()

getProject

public Project getProject()

getFile

public PsiFile getFile()

mergeWsWithCdataMarker

public static java.lang.String mergeWsWithCdataMarker(java.lang.String whiteSpace,
                                                      java.lang.String s,
                                                      int cdataPos)