Package com.intellij.lang.java

Class JavaFormattingModelBuilder

java.lang.Object

com.intellij.lang.java.JavaFormattingModelBuilder

All Implemented Interfaces:

FormattingModelBuilder, FormattingModelBuilderEx

public class JavaFormattingModelBuilder
extends java.lang.Object
implements FormattingModelBuilderEx

Constructor Summary

Constructors

Constructor and Description
JavaFormattingModelBuilder()

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.
FormattingModel	createModel(PsiElement element, CodeStyleSettings settings, FormattingMode formattingMode) Requests building the formatting model for a section of the file containing the specified PSI element and its children.
static TextRange	doGetRangeAffectingIndent(ASTNode elementAtOffset)
CommonCodeStyleSettings.IndentOptions	getIndentOptionsToUse(PsiFile file, FormatTextRanges ranges, CodeStyleSettings settings) Allows to adjust indent options to used during performing formatting operation on the given ranges of the given file.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.formatting.FormattingModelBuilderEx

createModel

Constructor Detail

JavaFormattingModelBuilder

public JavaFormattingModelBuilder()

Method Detail

createModel

public FormattingModel createModel(PsiElement element,
                                   CodeStyleSettings settings,
                                   FormattingMode formattingMode)

Description copied from interface: FormattingModelBuilderEx

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

Specified by:

createModel in interface FormattingModelBuilderEx

Parameters:

element - the top element for which formatting is requested.

settings - the code style settings used for formatting.

formattingMode - formatting mode

Returns:

the formatting model for the file.

See Also:

FormattingModelBuilderEx.createModel(PsiElement, TextRange, CodeStyleSettings, FormattingMode)

getIndentOptionsToUse

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

Description copied from interface: FormattingModelBuilderEx

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.

Specified by:

getIndentOptionsToUse in interface FormattingModelBuilderEx

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

createModel

public FormattingModel createModel(PsiElement element,
                                   CodeStyleSettings settings)

Description copied from interface: FormattingModelBuilder

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

Specified by:

createModel in interface FormattingModelBuilder

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

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

Description copied from interface: FormattingModelBuilder

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.

Specified by:

getRangeAffectingIndent in interface FormattingModelBuilder

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

doGetRangeAffectingIndent

public static TextRange doGetRangeAffectingIndent(ASTNode elementAtOffset)