Package com.intellij.formatting

Interface FormattingModelBuilder

All Known Subinterfaces:

CustomFormattingModelBuilder, DelegatingFormattingModelBuilder, FormattingModelBuilderEx

All Known Implementing Classes:

AbstractXmlTemplateFormattingModelBuilder, GroovyFormattingModelBuilder, HtmlFormattingModelBuilder, JavaFormattingModelBuilder, JsonFormattingBuilderModel, PropertiesFormattingModelBuilder, PythonFormattingModelBuilder, RestFormattingModelBuilder, RncFormattingModelBuilder, ShFormatterModelBuilder, SimpleTemplateLanguageFormattingModelBuilder, TemplateLanguageFormattingModelBuilder, XhtmlFormattingModelBuilder, XmlFormattingModelBuilder, YAMLFormattingModelBuilder

public interface FormattingModelBuilder

Allows a custom language plugin to build a formatting model for a file in the language, or for a portion of a file. A formatting model defines how a file is broken into non-whitespace blocks and different types of whitespace (alignment, indents and wraps) between them.

For certain aspects of the custom formatting to work properly, it is recommended to use TokenType.WHITE_SPACE as the language's whitespace tokens. See ParserDefinition

See Also:

LanguageFormatting, FormattingModelProvider.createFormattingModelForPsiFile(PsiFile, Block, CodeStyleSettings)

Method Summary

Modifier and Type	Method and Description
FormattingModel	createModel(PsiElement element, CodeStyleSettings settings) Requests building the formatting model for a section of the file containing the specified PSI element and its children.
default TextRange	getRangeAffectingIndent(PsiFile file, int offset, ASTNode elementAtOffset) Returns the TextRange which should be processed by the formatter in order to calculate the indent for a new line when a line break is inserted at the specified offset.

Method Detail

createModel

FormattingModel createModel(PsiElement element,
                            CodeStyleSettings settings)

Requests building the formatting model for a section of the file containing the specified PSI element and its children.

Parameters:

element - the top element for which formatting is requested.

settings - the code style settings used for formatting.

Returns:

the formatting model for the file.

getRangeAffectingIndent

default TextRange getRangeAffectingIndent(PsiFile file,
                                          int offset,
                                          ASTNode elementAtOffset)

Returns the TextRange which should be processed by the formatter in order to calculate the indent for a new line when a line break is inserted at the specified offset.

Parameters:

file - the file in which the line break is inserted.

offset - the line break offset.

elementAtOffset - the parameter at offset

Returns:

the range to reformat, or null if the default range should be used