Package com.intellij.formatting

Class FormatterImpl

java.lang.Object

com.intellij.formatting.FormatterEx

com.intellij.formatting.FormatterImpl

All Implemented Interfaces:

Formatter

public class FormatterImpl
extends FormatterEx

Constructor Summary

Constructors

Constructor and Description
FormatterImpl()

Method Summary

Modifier and Type	Method and Description
int	adjustLineIndent(FormattingModel model, CodeStyleSettings settings, CommonCodeStyleSettings.IndentOptions indentOptions, int offset, TextRange affectedRange)
void	adjustLineIndentsForRange(FormattingModel model, CodeStyleSettings settings, CommonCodeStyleSettings.IndentOptions indentOptions, TextRange rangeToAdjust)
Alignment	createAlignment(boolean applyToNonFirstBlocksOnLine, Alignment.Anchor anchor)
Alignment	createChildAlignment(Alignment base)
Wrap	createChildWrap(Wrap parentWrap, WrapType wrapType, boolean wrapFirstElement)
Spacing	createDependentLFSpacing(int minSpaces, int maxSpaces, java.util.List<TextRange> dependentRegion, boolean keepLineBreaks, int keepBlankLines, DependentSpacingRule rule)
Spacing	createDependentLFSpacing(int minSpaces, int maxSpaces, TextRange dependencyRange, boolean keepLineBreaks, int keepBlankLines, DependentSpacingRule rule)
FormattingModel	createFormattingModelForPsiFile(PsiFile file, Block rootBlock, CodeStyleSettings settings)
Spacing	createKeepingFirstColumnSpacing(int minSpace, int maxSpace, boolean keepLineBreaks, int keepBlankLines)
Spacing	createSafeSpacing(boolean shouldKeepLineBreaks, int keepBlankLines)
Spacing	createSpacing(int minOffset, int maxOffset, int minLineFeeds, boolean keepLineBreaks, int keepBlankLines)
Spacing	createSpacing(int minSpaces, int maxSpaces, int minLineFeeds, boolean keepLineBreaks, int keepBlankLines, int prefLineFeeds)
Wrap	createWrap(WrapType type, boolean wrapFirstElement)
void	format(FormattingModel model, CodeStyleSettings settings, CommonCodeStyleSettings.IndentOptions indentOptions, FormatTextRanges affectedRanges)
void	formatAroundRange(FormattingModel model, CodeStyleSettings settings, PsiFile file, TextRange textRange)
void	formatWithoutModifications(FormattingDocumentModel model, Block rootBlock, CodeStyleSettings settings, CommonCodeStyleSettings.IndentOptions indentOptions, TextRange affectedRange)
Indent	getAbsoluteLabelIndent()
Indent	getAbsoluteNoneIndent()
Indent	getContinuationIndent(boolean relative)
Indent	getContinuationWithoutFirstIndent(boolean relative)
Indent	getIndent(Indent.Type type, boolean relativeToDirectParent, boolean enforceIndentToChildren)
Indent	getIndent(Indent.Type type, int spaces, boolean relativeToDirectParent, boolean enforceIndentToChildren)
Indent	getLabelIndent()
java.lang.String	getLineIndent(FormattingModel model, CodeStyleSettings settings, CommonCodeStyleSettings.IndentOptions indentOptions, int offset, TextRange affectedRange)
int	getMinLineFeedsBeforeBlockAtOffset(FormattingModel model, int offset) Calculates minimum number of line feeds that should precede block starting at given offset, as dictated by formatting model.
Indent	getNoneIndent()
Indent	getNormalIndent(boolean relative)
Spacing	getReadOnlySpacing()
Indent	getSmartIndent(Indent.Type type)
Indent	getSpaceIndent(int spaces, boolean relative)
int	getSpacingForBlockAtOffset(FormattingModel model, int offset) Calculates minimum spacing, allowed by formatting model (in columns) for a block starting at given offset, relative to its previous sibling block.
static java.lang.String	getText(FormattingDocumentModel documentModel)
boolean	isDisabled()
<T> T	runWithFormattingDisabled(Computable<T> runnable)
void	setProgressTask(FormattingProgressTask progressIndicator)

Methods inherited from class com.intellij.formatting.FormatterEx

getInstance, getInstanceEx

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatterImpl

public FormatterImpl()

Method Detail

createAlignment

public Alignment createAlignment(boolean applyToNonFirstBlocksOnLine,
                                 Alignment.Anchor anchor)

createChildAlignment

public Alignment createChildAlignment(Alignment base)

getNormalIndent

public Indent getNormalIndent(boolean relative)

getNoneIndent

public Indent getNoneIndent()

setProgressTask

public void setProgressTask(FormattingProgressTask progressIndicator)

Specified by:

setProgressTask in class FormatterEx

getSpacingForBlockAtOffset

public int getSpacingForBlockAtOffset(FormattingModel model,
                                      int offset)

Description copied from class: FormatterEx

Calculates minimum spacing, allowed by formatting model (in columns) for a block starting at given offset, relative to its previous sibling block. Returns -1, if required block cannot be found at provided offset, or spacing cannot be calculated due to some other reason.

Specified by:

getSpacingForBlockAtOffset in class FormatterEx

getMinLineFeedsBeforeBlockAtOffset

public int getMinLineFeedsBeforeBlockAtOffset(FormattingModel model,
                                              int offset)

Description copied from class: FormatterEx

Calculates minimum number of line feeds that should precede block starting at given offset, as dictated by formatting model. Returns -1, if required block cannot be found at provided offset, or spacing cannot be calculated due to some other reason.

Specified by:

getMinLineFeedsBeforeBlockAtOffset in class FormatterEx

createWrap

public Wrap createWrap(WrapType type,
                       boolean wrapFirstElement)

createChildWrap

public Wrap createChildWrap(Wrap parentWrap,
                            WrapType wrapType,
                            boolean wrapFirstElement)

createSpacing

public Spacing createSpacing(int minOffset,
                             int maxOffset,
                             int minLineFeeds,
                             boolean keepLineBreaks,
                             int keepBlankLines)

getReadOnlySpacing

public Spacing getReadOnlySpacing()

createDependentLFSpacing

public Spacing createDependentLFSpacing(int minSpaces,
                                        int maxSpaces,
                                        TextRange dependencyRange,
                                        boolean keepLineBreaks,
                                        int keepBlankLines,
                                        DependentSpacingRule rule)

createDependentLFSpacing

public Spacing createDependentLFSpacing(int minSpaces,
                                        int maxSpaces,
                                        java.util.List<TextRange> dependentRegion,
                                        boolean keepLineBreaks,
                                        int keepBlankLines,
                                        DependentSpacingRule rule)

format

public void format(FormattingModel model,
                   CodeStyleSettings settings,
                   CommonCodeStyleSettings.IndentOptions indentOptions,
                   FormatTextRanges affectedRanges)
            throws IncorrectOperationException

Specified by:

format in class FormatterEx

Throws:

IncorrectOperationException

formatWithoutModifications

public void formatWithoutModifications(FormattingDocumentModel model,
                                       Block rootBlock,
                                       CodeStyleSettings settings,
                                       CommonCodeStyleSettings.IndentOptions indentOptions,
                                       TextRange affectedRange)
                                throws IncorrectOperationException

Throws:

IncorrectOperationException

adjustLineIndentsForRange

public void adjustLineIndentsForRange(FormattingModel model,
                                      CodeStyleSettings settings,
                                      CommonCodeStyleSettings.IndentOptions indentOptions,
                                      TextRange rangeToAdjust)

Specified by:

adjustLineIndentsForRange in class FormatterEx

formatAroundRange

public void formatAroundRange(FormattingModel model,
                              CodeStyleSettings settings,
                              PsiFile file,
                              TextRange textRange)

Specified by:

formatAroundRange in class FormatterEx

adjustLineIndent

public int adjustLineIndent(FormattingModel model,
                            CodeStyleSettings settings,
                            CommonCodeStyleSettings.IndentOptions indentOptions,
                            int offset,
                            TextRange affectedRange)
                     throws IncorrectOperationException

Specified by:

adjustLineIndent in class FormatterEx

Throws:

IncorrectOperationException

getLineIndent

public java.lang.String getLineIndent(FormattingModel model,
                                      CodeStyleSettings settings,
                                      CommonCodeStyleSettings.IndentOptions indentOptions,
                                      int offset,
                                      TextRange affectedRange)

Specified by:

getLineIndent in class FormatterEx

getText

public static java.lang.String getText(FormattingDocumentModel documentModel)

createFormattingModelForPsiFile

public FormattingModel createFormattingModelForPsiFile(PsiFile file,
                                                       Block rootBlock,
                                                       CodeStyleSettings settings)

getSpaceIndent

public Indent getSpaceIndent(int spaces,
                             boolean relative)

getIndent

public Indent getIndent(Indent.Type type,
                        boolean relativeToDirectParent,
                        boolean enforceIndentToChildren)

getSmartIndent

public Indent getSmartIndent(Indent.Type type)

getIndent

public Indent getIndent(Indent.Type type,
                        int spaces,
                        boolean relativeToDirectParent,
                        boolean enforceIndentToChildren)

getAbsoluteLabelIndent

public Indent getAbsoluteLabelIndent()

createSafeSpacing

public Spacing createSafeSpacing(boolean shouldKeepLineBreaks,
                                 int keepBlankLines)

createKeepingFirstColumnSpacing

public Spacing createKeepingFirstColumnSpacing(int minSpace,
                                               int maxSpace,
                                               boolean keepLineBreaks,
                                               int keepBlankLines)

createSpacing

public Spacing createSpacing(int minSpaces,
                             int maxSpaces,
                             int minLineFeeds,
                             boolean keepLineBreaks,
                             int keepBlankLines,
                             int prefLineFeeds)

getAbsoluteNoneIndent

public Indent getAbsoluteNoneIndent()

getLabelIndent

public Indent getLabelIndent()

getContinuationIndent

public Indent getContinuationIndent(boolean relative)

getContinuationWithoutFirstIndent

public Indent getContinuationWithoutFirstIndent(boolean relative)

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in class FormatterEx

runWithFormattingDisabled

public <T> T runWithFormattingDisabled(Computable<T> runnable)