Package com.intellij.formatting

Interface FormattingDocumentModel

All Known Implementing Classes:

FormattingDocumentModelImpl

public interface FormattingDocumentModel

Represents a model of the document containing the formatted text, as seen by the formatter. Allows a formatter to access information about the document.

See Also:

FormattingModel.getDocumentModel()

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.
boolean	containsWhiteSpaceSymbolsOnly(int startOffset, int endOffset) Allows to answer if all document symbols from [startOffset; endOffset) region are treated as white spaces by formatter.
Document	getDocument()
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.

Method Detail

getLineNumber

int getLineNumber(int offset)

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

Parameters:

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

Returns:

the line number corresponding to the offset.

getLineStartOffset

int getLineStartOffset(int line)

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

Parameters:

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

Returns:

the start offset of the line.

getText

java.lang.CharSequence getText(TextRange textRange)

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

Parameters:

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

Returns:

the text at the specified text range.

getTextLength

int getTextLength()

Returns the length of the entire document text.

Returns:

the document text length.

getDocument

Document getDocument()

containsWhiteSpaceSymbolsOnly

boolean containsWhiteSpaceSymbolsOnly(int startOffset,
                                      int endOffset)

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

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

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

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