Package com.intellij.formatting

Interface FormattingModelBuilderEx

All Superinterfaces:

FormattingModelBuilder

All Known Implementing Classes:

JavaFormattingModelBuilder, PythonFormattingModelBuilder, RestFormattingModelBuilder

public interface FormattingModelBuilderEx
extends FormattingModelBuilder

Method Summary

Modifier and Type	Method and Description
FormattingModel	createModel(PsiElement element, CodeStyleSettings settings, FormattingMode mode) Requests building the formatting model for a section of the file containing the specified PSI element and its children.
default FormattingModel	createModel(PsiElement element, TextRange range, CodeStyleSettings settings, FormattingMode mode) Requests building the formatting model for a section of the file containing the specified PSI element and its children.
CommonCodeStyleSettings.IndentOptions	getIndentOptionsToUse(PsiFile file, FormatTextRanges ranges, CodeStyleSettings settings) Deprecated. Use FileIndentOptionsProvider instead.

Methods inherited from interface com.intellij.formatting.FormattingModelBuilder

createModel, getRangeAffectingIndent

Method Detail

createModel

FormattingModel createModel(PsiElement element,
                            CodeStyleSettings settings,
                            FormattingMode mode)

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.

mode - formatting mode

Returns:

the formatting model for the file.

See Also:

createModel(PsiElement, TextRange, CodeStyleSettings, FormattingMode)

createModel

default FormattingModel createModel(PsiElement element,
                                    TextRange range,
                                    CodeStyleSettings settings,
                                    FormattingMode mode)

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.

range - the range for which a model should be built.

settings - the code style settings used for formatting.

mode - formatting mode.

Returns:

the formatting model for the file.

getIndentOptionsToUse

@Deprecated
CommonCodeStyleSettings.IndentOptions getIndentOptionsToUse(PsiFile file,
                                                            FormatTextRanges ranges,
                                                            CodeStyleSettings settings)

Deprecated. Use FileIndentOptionsProvider instead.

Allows to adjust indent options to used during performing formatting operation on the given ranges of the given file.

Default algorithm is to query given settings for indent options using given file's language as a key.

Parameters:

file - target file which content is going to be reformatted

ranges - given file's ranges to reformat

settings - code style settings holder

Returns:

indent options to use for the target formatting operation (if any adjustment is required); null to trigger default algorithm usage

See Also:

FileIndentOptionsProvider