Package com.intellij.formatting

Class FormatterEx

java.lang.Object

com.intellij.formatting.FormatterEx

All Implemented Interfaces:

Formatter

Direct Known Subclasses:

FormatterImpl

public abstract class FormatterEx
extends java.lang.Object
implements Formatter

Constructor Summary

Constructors

Constructor and Description
FormatterEx()

Method Summary

Modifier and Type	Method and Description
abstract int	adjustLineIndent(FormattingModel psiBasedFormattingModel, CodeStyleSettings settings, CommonCodeStyleSettings.IndentOptions indentOptions, int offset, TextRange affectedRange)
abstract void	adjustLineIndentsForRange(FormattingModel model, CodeStyleSettings settings, CommonCodeStyleSettings.IndentOptions indentOptions, TextRange rangeToAdjust)
Alignment	createAlignment(boolean allowBackwardShift, Alignment.Anchor anchor) Provides implementation for Alignment.createAlignment(boolean, Alignment.Anchor).
Alignment	createChildAlignment(Alignment base) Provides
Wrap	createChildWrap(Wrap parentWrap, WrapType wrapType, boolean wrapFirstElement)
Spacing	createDependentLFSpacing(int minSpaces, int maxSpaces, java.util.List<TextRange> dependencyRange, 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 minSpaces, int maxSpaces, boolean keepLineBreaks, int keepBlankLines)
Spacing	createSafeSpacing(boolean keepLineBreaks, int keepBlankLines)
Spacing	createSpacing(int minSpaces, int maxSpaces, 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)
abstract void	format(FormattingModel model, CodeStyleSettings settings, CommonCodeStyleSettings.IndentOptions indentOptions, FormatTextRanges affectedRanges)
abstract void	formatAroundRange(FormattingModel model, CodeStyleSettings settings, PsiFile file, TextRange textRange)
Indent	getAbsoluteLabelIndent()
Indent	getAbsoluteNoneIndent()
Indent	getContinuationIndent(boolean relativeToDirectParent)
Indent	getContinuationWithoutFirstIndent(boolean relativeToDirectParent)
Indent	getIndent(Indent.Type type, boolean relativeToDirectParent, boolean enforceIndentToChildren)
Indent	getIndent(Indent.Type type, int spaces, boolean relativeToDirectParent, boolean enforceIndentToChildren)
static FormatterEx	getInstance()
static FormatterEx	getInstanceEx()
Indent	getLabelIndent()
abstract java.lang.String	getLineIndent(FormattingModel psiBasedFormattingModel, CodeStyleSettings settings, CommonCodeStyleSettings.IndentOptions indentOptions, int offset, TextRange affectedRange)
abstract 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 relativeToDirectParent)
Spacing	getReadOnlySpacing()
Indent	getSmartIndent(Indent.Type type)
Indent	getSpaceIndent(int spaces, boolean relativeToDirectParent)
abstract 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.
abstract boolean	isDisabled()
abstract void	setProgressTask(FormattingProgressTask progressIndicator)

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatterEx

public FormatterEx()

Method Detail

getInstance

public static FormatterEx getInstance()

Specified by:

getInstance in interface Formatter

format

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

Throws:

IncorrectOperationException

adjustLineIndent

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

Throws:

IncorrectOperationException

getLineIndent

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

isDisabled

public abstract boolean isDisabled()

adjustLineIndentsForRange

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

formatAroundRange

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

setProgressTask

public abstract void setProgressTask(FormattingProgressTask progressIndicator)

getSpacingForBlockAtOffset

public abstract 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. Returns -1, if required block cannot be found at provided offset, or spacing cannot be calculated due to some other reason.

getMinLineFeedsBeforeBlockAtOffset

public abstract 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. Returns -1, if required block cannot be found at provided offset, or spacing cannot be calculated due to some other reason.

getInstanceEx

public static FormatterEx getInstanceEx()

getNormalIndent

public Indent getNormalIndent(boolean relativeToDirectParent)

getNoneIndent

public Indent getNoneIndent()

getAbsoluteNoneIndent

public Indent getAbsoluteNoneIndent()

getAbsoluteLabelIndent

public Indent getAbsoluteLabelIndent()

getLabelIndent

public Indent getLabelIndent()

getContinuationIndent

public Indent getContinuationIndent(boolean relativeToDirectParent)

getContinuationWithoutFirstIndent

public Indent getContinuationWithoutFirstIndent(boolean relativeToDirectParent)

getSpaceIndent

public Indent getSpaceIndent(int spaces,
                             boolean relativeToDirectParent)

getIndent

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

getIndent

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

getSmartIndent

public Indent getSmartIndent(Indent.Type type)

createWrap

public Wrap createWrap(WrapType type,
                       boolean wrapFirstElement)

createChildWrap

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

createAlignment

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

Provides implementation for Alignment.createAlignment(boolean, Alignment.Anchor).

Parameters:

allowBackwardShift - flag that specifies if former aligned block may be shifted to right in order to align to subsequent aligned block

anchor - alignment anchor

Returns:

alignment object with the given settings

createChildAlignment

public Alignment createChildAlignment(Alignment base)

Provides

Parameters:

base - base alignment to use within returned alignment object

Returns:

alignment object with the given alignment defined as a 'base alignment'

createSpacing

public Spacing createSpacing(int minSpaces,
                             int maxSpaces,
                             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> dependencyRange,
                                        boolean keepLineBreaks,
                                        int keepBlankLines,
                                        DependentSpacingRule rule)

createSafeSpacing

public Spacing createSafeSpacing(boolean keepLineBreaks,
                                 int keepBlankLines)

createKeepingFirstColumnSpacing

public Spacing createKeepingFirstColumnSpacing(int minSpaces,
                                               int maxSpaces,
                                               boolean keepLineBreaks,
                                               int keepBlankLines)

createSpacing

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

createFormattingModelForPsiFile

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