Package com.intellij.psi.formatter

Class FormattingDocumentModelImpl

java.lang.Object

com.intellij.psi.formatter.FormattingDocumentModelImpl

All Implemented Interfaces:

FormattingDocumentModel

public class FormattingDocumentModelImpl
extends java.lang.Object
implements FormattingDocumentModel

Constructor Summary

Constructors

Constructor and Description
FormattingDocumentModelImpl(Document document, PsiFile file)

Method Summary

Modifier and Type	Method and Description
java.lang.CharSequence	adjustWhiteSpaceIfNecessary(java.lang.CharSequence whiteSpaceText, int startOffset, int endOffset, ASTNode nodeAfter, boolean changedViaPsi) There is a possible case that white space to apply should be additionally adjusted because of formatter processing.
static boolean	canUseDocumentModel(Document document, PsiFile file)
boolean	containsWhiteSpaceSymbolsOnly(int startOffset, int endOffset) Allows to answer if all document symbols from [startOffset; endOffset) region are treated as white spaces by formatter.
static FormattingDocumentModelImpl	createOn(PsiFile file)
Document	getDocument()
static Document	getDocumentToBeUsedFor(PsiFile file)
PsiFile	getFile()
int	getLineNumber(int offset) Returns the line number corresponding to the specified offset in the document.
int	getLineStartOffset(int line) Returns the offset corresponding to the start of the specified line in the document.
java.lang.CharSequence	getText(TextRange textRange) Returns the text contained in the specified text range of the document.
int	getTextLength() Returns the length of the entire document text.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormattingDocumentModelImpl

public FormattingDocumentModelImpl(Document document,
                                   PsiFile file)

Method Detail

createOn

public static FormattingDocumentModelImpl createOn(PsiFile file)

getDocumentToBeUsedFor

public static Document getDocumentToBeUsedFor(PsiFile file)

getLineNumber

public int getLineNumber(int offset)

Description copied from interface: FormattingDocumentModel

Returns the line number corresponding to the specified offset in the document.

Specified by:

getLineNumber in interface FormattingDocumentModel

Parameters:

offset - the offset for which the line number is requested.

Returns:

the line number corresponding to the offset.

getLineStartOffset

public int getLineStartOffset(int line)

Description copied from interface: FormattingDocumentModel

Returns the offset corresponding to the start of the specified line in the document.

Specified by:

getLineStartOffset in interface FormattingDocumentModel

Parameters:

line - the line number for which the offset is requested.

Returns:

the start offset of the line.

getText

public java.lang.CharSequence getText(TextRange textRange)

Description copied from interface: FormattingDocumentModel

Returns the text contained in the specified text range of the document.

Specified by:

getText in interface FormattingDocumentModel

Parameters:

textRange - the text range for which the text is requested.

Returns:

the text at the specified text range.

getTextLength

public int getTextLength()

Description copied from interface: FormattingDocumentModel

Returns the length of the entire document text.

Specified by:

getTextLength in interface FormattingDocumentModel

Returns:

the document text length.

getDocument

public Document getDocument()

Specified by:

getDocument in interface FormattingDocumentModel

getFile

public PsiFile getFile()

containsWhiteSpaceSymbolsOnly

public boolean containsWhiteSpaceSymbolsOnly(int startOffset,
                                             int endOffset)

Description copied from interface: FormattingDocumentModel

Allows to answer if all document symbols from [startOffset; endOffset) region are treated as white spaces by formatter.

Specified by:

containsWhiteSpaceSymbolsOnly in interface FormattingDocumentModel

Parameters:

startOffset - target start document offset (inclusive)

endOffset - target end document offset (exclusive)

Returns:

true if all document symbols from [startOffset; endOffset) region are treated as white spaces by formatter; false otherwise

adjustWhiteSpaceIfNecessary

public java.lang.CharSequence adjustWhiteSpaceIfNecessary(java.lang.CharSequence whiteSpaceText,
                                                          int startOffset,
                                                          int endOffset,
                                                          ASTNode nodeAfter,
                                                          boolean changedViaPsi)

Description copied from interface: FormattingDocumentModel

There is a possible case that white space to apply should be additionally adjusted because of formatter processing. That is true, for example, for Python where it may be mandatory to use '\' symbol at multi-line expression.

Current method adjusts given white space text if necessary.

Specified by:

adjustWhiteSpaceIfNecessary in interface FormattingDocumentModel

Parameters:

whiteSpaceText - white space text to use by default

startOffset - start offset of the document text that is intended to be replaced by the given white space text (inclusive)

endOffset - end offset of the document text that is intended to be replaced by the given white space text (exclusive)

nodeAfter - the AST node following the block, if known

changedViaPsi - flag that identifies whether formatter introduces changes via PSI tree or directly via the document

Returns:

white space to use for replacing document symbols at [startOffset; endOffset) region

canUseDocumentModel

public static boolean canUseDocumentModel(Document document,
                                          PsiFile file)