Package com.intellij.formatting

Interface Formatter

All Known Implementing Classes:

FormatterEx, FormatterImpl

public interface Formatter

Method Summary

Modifier and Type	Method and Description
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)
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 Formatter	getInstance()
Indent	getLabelIndent()
Indent	getNoneIndent()
Indent	getNormalIndent(boolean relativeToDirectParent)
Spacing	getReadOnlySpacing()
Indent	getSmartIndent(Indent.Type type)
Indent	getSpaceIndent(int spaces, boolean relativeToDirectParent)

Method Detail

getInstance

static Formatter getInstance()

getNormalIndent

Indent getNormalIndent(boolean relativeToDirectParent)

getNoneIndent

Indent getNoneIndent()

getAbsoluteNoneIndent

Indent getAbsoluteNoneIndent()

getAbsoluteLabelIndent

Indent getAbsoluteLabelIndent()

getLabelIndent

Indent getLabelIndent()

getContinuationIndent

Indent getContinuationIndent(boolean relativeToDirectParent)

getContinuationWithoutFirstIndent

Indent getContinuationWithoutFirstIndent(boolean relativeToDirectParent)

getSpaceIndent

Indent getSpaceIndent(int spaces,
                      boolean relativeToDirectParent)

getIndent

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

getIndent

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

getSmartIndent

Indent getSmartIndent(Indent.Type type)

createWrap

Wrap createWrap(WrapType type,
                boolean wrapFirstElement)

createChildWrap

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

createAlignment

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

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

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

getReadOnlySpacing

Spacing getReadOnlySpacing()

createDependentLFSpacing

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

createDependentLFSpacing

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

createSafeSpacing

Spacing createSafeSpacing(boolean keepLineBreaks,
                          int keepBlankLines)

createKeepingFirstColumnSpacing

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

createSpacing

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

createFormattingModelForPsiFile

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