CodeStyleManagerImpl (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.psi.codeStyle.CodeStyleManager
- - com.intellij.psi.impl.source.codeStyle.CodeStyleManagerImpl

All Implemented Interfaces:: FormattingModeAwareIndentAdjuster

public class CodeStyleManagerImpl
extends CodeStyleManager
implements FormattingModeAwareIndentAdjuster

Constructor Summary

Constructors
Constructor and Description

CodeStyleManagerImpl(Project project)

Constructors
Constructor and Description
`CodeStyleManagerImpl(Project project)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`adjustLineIndent(Document document, int offset)` Reformats the line at the specified offset in the specified file, modifying only the line indent and leaving all other whitespace intact.
`int`	`adjustLineIndent(Document document, int offset, FormattingMode mode)` Adjust line indent at document offset using `mode`.
`int`	`adjustLineIndent(PsiFile file, int offset)` Reformats the line at the specified offset in the specified file, modifying only the line indent and leaving all other whitespace intact.
`void`	`adjustLineIndent(PsiFile file, TextRange rangeToAdjust)` Re-formats the specified range of a file, modifying only line indents and leaving all other whitespace intact.
`java.lang.String`	`fillIndent(Indent indent, FileType fileType)`
`static PsiElement`	`findWhiteSpaceNode(PsiFile file, int offset)` Allows to check if given offset points to white space element within the given PSI file and return that white space element in the case of positive answer.
`static void`	`formatRanges(PsiFile file, FormatTextRanges ranges, java.lang.Runnable formatAction)`
`FormattingMode`	`getCurrentFormattingMode()`
`DocCommentSettings`	`getDocCommentSettings(PsiFile file)`
`Indent`	`getIndent(java.lang.String text, FileType fileType)`
`java.lang.String`	`getLineIndent(Document document, int offset)` Calculates the indent that should be used for the current line in the specified editor.
`java.lang.String`	`getLineIndent(PsiFile file, int offset)` Calculates the indent that should be used for the specified line in the specified file.
`java.lang.String`	`getLineIndent(PsiFile file, int offset, FormattingMode mode)` Calculates the indent that should be used for the specified line in the specified file with the given formatting mode.
`int`	`getMinLineFeeds(PsiFile file, int offset)` Calculates minimum number of line feeds that should precede block starting at given offset, as dictated by formatting model.
`Project`	`getProject()` Gets the project with which the code style manager is associated.
`int`	`getSpacing(PsiFile file, 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 TextRange`	`insertNewLineIndentMarker(PsiFile file, Document document, int offset)` Formatter trims line that contains white spaces symbols only, however, there is a possible case that we want to preserve them for particular line (e.g.
`boolean`	`isLineToBeIndented(PsiFile file, int offset)` Deprecated.
`boolean`	`isSequentialProcessingAllowed()` Formatting may be executed sequentially, i.e.
`<T> T`	`performActionWithFormatterDisabled(Computable<T> r)`
`void`	`performActionWithFormatterDisabled(java.lang.Runnable r)` Disables automatic formatting of modified PSI elements, runs the specified operation and re-enables the formatting.
`<T extends java.lang.Throwable> void`	`performActionWithFormatterDisabled(ThrowableRunnable<T> r)`
`PsiElement`	`reformat(PsiElement element)` Reformats the contents of the specified PSI element, enforces braces and splits import statements according to the user's code style.
`PsiElement`	`reformat(PsiElement element, boolean canChangeWhiteSpacesOnly)` Reformats the contents of the specified PSI element, and optionally enforces braces and splits import statements according to the user's code style.
`void`	`reformatNewlyAddedElement(ASTNode parent, ASTNode addedElement)` Reformats line indents inside new element and reformats white spaces around it
`PsiElement`	`reformatRange(PsiElement element, int startOffset, int endOffset)` Reformats part of the contents of the specified PSI element, enforces braces and splits import statements according to the user's code style.
`PsiElement`	`reformatRange(PsiElement element, int startOffset, int endOffset, boolean canChangeWhiteSpacesOnly)` Reformats part of the contents of the specified PSI element, and optionally enforces braces and splits import statements according to the user's code style.
`void`	`reformatText(PsiFile file, java.util.Collection<? extends TextRange> ranges, Editor editor)`
`void`	`reformatText(PsiFile file, java.util.Collection<TextRange> ranges)` Re-formats a ranges of text in the specified file.
`void`	`reformatText(PsiFile file, int startOffset, int endOffset)` Delegates to the `CodeStyleManager.reformatText(PsiFile, Collection)` with the single range defined by the given offsets.
`void`	`reformatTextWithContext(PsiFile file, ChangedRangesInfo info)`
`void`	`runWithDocCommentFormattingDisabled(PsiFile file, java.lang.Runnable runnable)` Run the given runnable disabling doc comment formatting.
`void`	`scheduleIndentAdjustment(Document document, int offset)` Performs a delayed indent adjustment for large documents bigger than `FormatterBasedIndentAdjuster.MAX_SYNCHRONOUS_ADJUSTMENT_DOC_SIZE` by scheduling it to a time when the document is committed.
`static void`	`setSequentialProcessingAllowed(boolean allowed)` Allows to define if `sequential processing` should be allowed.
`Indent`	`zeroIndent()`

Methods inherited from class com.intellij.psi.codeStyle.CodeStyleManager
getCurrentFormattingMode, getInstance, getInstance, reformatTextWithContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CodeStyleManagerImpl
```
public CodeStyleManagerImpl(Project project)
```
- Method Detail
  - getProject
```
public Project getProject()
```
    Description copied from class: CodeStyleManager
    
    Gets the project with which the code style manager is associated.
    
    Specified by:
    
    getProject in class CodeStyleManager
    
    Returns:
    
    the project instance.
  - reformat
```
public PsiElement reformat(PsiElement element)
                    throws IncorrectOperationException
```
    Description copied from class: CodeStyleManager
    
    Reformats the contents of the specified PSI element, enforces braces and splits import statements according to the user's code style.
    
    Specified by:
    
    reformat in class CodeStyleManager
    
    Parameters:
    
    element - the element to reformat.
    
    Returns:
    
    the element in the PSI tree after the reformat operation corresponding to the original element.
    
    Throws:
    
    IncorrectOperationException - if the file to reformat is read-only.
    
    See Also:
    
    CodeStyleManager.reformatText(PsiFile, int, int)
  - reformat
```
public PsiElement reformat(PsiElement element,
                           boolean canChangeWhiteSpacesOnly)
                    throws IncorrectOperationException
```
    Description copied from class: CodeStyleManager
    
    Reformats the contents of the specified PSI element, and optionally enforces braces and splits import statements according to the user's code style.
    
    Specified by:
    
    reformat in class CodeStyleManager
    
    Parameters:
    
    element - the element to reformat.
    
    canChangeWhiteSpacesOnly - if true, only reformatting is performed; if false, braces and import statements also can be modified if necessary.
    
    Returns:
    
    the element in the PSI tree after the reformat operation corresponding to the original element.
    
    Throws:
    
    IncorrectOperationException - if the file to reformat is read-only.
    
    See Also:
    
    CodeStyleManager.reformatText(PsiFile, int, int)
  - reformatRange
```
public PsiElement reformatRange(PsiElement element,
                                int startOffset,
                                int endOffset,
                                boolean canChangeWhiteSpacesOnly)
                         throws IncorrectOperationException
```
    Description copied from class: CodeStyleManager
    
    Reformats part of the contents of the specified PSI element, and optionally enforces braces and splits import statements according to the user's code style.
    
    Specified by:
    
    reformatRange in class CodeStyleManager
    
    Parameters:
    
    element - the element to reformat.
    
    startOffset - the start offset in the document of the text range to reformat.
    
    endOffset - the end offset in the document of the text range to reformat.
    
    canChangeWhiteSpacesOnly - if true, only reformatting is performed; if false, braces and import statements also can be modified if necessary.
    
    Returns:
    
    the element in the PSI tree after the reformat operation corresponding to the original element.
    
    Throws:
    
    IncorrectOperationException - if the file to reformat is read-only.
    
    See Also:
    
    CodeStyleManager.reformatText(PsiFile, int, int)
  - reformatRange
```
public PsiElement reformatRange(PsiElement element,
                                int startOffset,
                                int endOffset)
                         throws IncorrectOperationException
```
    Description copied from class: CodeStyleManager
    
    Reformats part of the contents of the specified PSI element, enforces braces and splits import statements according to the user's code style.
    
    Specified by:
    
    reformatRange in class CodeStyleManager
    
    Parameters:
    
    element - the element to reformat.
    
    startOffset - the start offset in the document of the text range to reformat.
    
    endOffset - the end offset in the document of the text range to reformat.
    
    Returns:
    
    the element in the PSI tree after the reformat operation corresponding to the original element.
    
    Throws:
    
    IncorrectOperationException - if the file to reformat is read-only.
    
    See Also:
    
    CodeStyleManager.reformatText(PsiFile, int, int)
  - reformatText
```
public void reformatText(PsiFile file,
                         int startOffset,
                         int endOffset)
                  throws IncorrectOperationException
```
    Description copied from class: CodeStyleManager
    
    Delegates to the CodeStyleManager.reformatText(PsiFile, Collection) with the single range defined by the given offsets.
    
    Specified by:
    
    reformatText in class CodeStyleManager
    
    Parameters:
    
    file - the file to reformat.
    
    startOffset - the start of the text range to reformat.
    
    endOffset - the end of the text range to reformat.
    
    Throws:
    
    IncorrectOperationException - if the file to reformat is read-only.
  - reformatText
```
public void reformatText(PsiFile file,
                         java.util.Collection<TextRange> ranges)
                  throws IncorrectOperationException
```
    Description copied from class: CodeStyleManager
    
    Re-formats a ranges of text in the specified file. This method works faster than CodeStyleManager.reformatRange(PsiElement, int, int) but invalidates the PSI structure for the file.
    
    Specified by:
    
    reformatText in class CodeStyleManager
    
    Parameters:
    
    file - the file to reformat
    
    ranges - ranges to process
    
    Throws:
    
    IncorrectOperationException - if the file to reformat is read-only.
  - reformatTextWithContext
```
public void reformatTextWithContext(PsiFile file,
                                    ChangedRangesInfo info)
                             throws IncorrectOperationException
```
    Specified by:
    
    reformatTextWithContext in class CodeStyleManager
    
    Throws:
    
    IncorrectOperationException
  - reformatText
```
public void reformatText(PsiFile file,
                         java.util.Collection<? extends TextRange> ranges,
                         Editor editor)
                  throws IncorrectOperationException
```
    Throws:
    
    IncorrectOperationException
  - formatRanges
```
public static void formatRanges(PsiFile file,
                                FormatTextRanges ranges,
                                java.lang.Runnable formatAction)
```
  - reformatNewlyAddedElement
```
public void reformatNewlyAddedElement(ASTNode parent,
                                      ASTNode addedElement)
                               throws IncorrectOperationException
```
    Description copied from class: CodeStyleManager
    
    Reformats line indents inside new element and reformats white spaces around it
    
    Specified by:
    
    reformatNewlyAddedElement in class CodeStyleManager
    
    Parameters:
    
    parent - - added element parent
    
    addedElement - - new element
    
    Throws:
    
    IncorrectOperationException - if the operation fails for some reason (for example, the file is read-only).
  - adjustLineIndent
```
public int adjustLineIndent(PsiFile file,
                            int offset)
                     throws IncorrectOperationException
```
    Description copied from class: CodeStyleManager
    
    Reformats the line at the specified offset in the specified file, modifying only the line indent and leaving all other whitespace intact.
    
    Specified by:
    
    adjustLineIndent in class CodeStyleManager
    
    Parameters:
    
    file - the file to reformat.
    
    offset - the offset the line at which should be reformatted.
    
    Throws:
    
    IncorrectOperationException - if the file is read-only.
    
    See Also:
    
    CodeStyleManager.scheduleIndentAdjustment(Document, int)
  - adjustLineIndent
```
public int adjustLineIndent(Document document,
                            int offset,
                            FormattingMode mode)
```
    Description copied from interface: FormattingModeAwareIndentAdjuster
    
    Adjust line indent at document offset using mode.
    
    Specified by:
    
    adjustLineIndent in interface FormattingModeAwareIndentAdjuster
    
    Parameters:
    
    document - The document to adjust line indent in.
    
    offset - The offset in the document.
    
    mode - The mode: FormattingMode.ADJUST_INDENT or FormattingMode.ADJUST_INDENT_ON_ENTER
    
    Returns:
    
    Adjusted offset.
  - adjustLineIndent
```
public int adjustLineIndent(Document document,
                            int offset)
```
    Description copied from class: CodeStyleManager
    
    Reformats the line at the specified offset in the specified file, modifying only the line indent and leaving all other whitespace intact.
    
    Specified by:
    
    adjustLineIndent in class CodeStyleManager
    
    Parameters:
    
    document - the document to reformat.
    
    offset - the offset the line at which should be reformatted.
    
    See Also:
    
    CodeStyleManager.scheduleIndentAdjustment(Document, int)
  - adjustLineIndent
```
public void adjustLineIndent(PsiFile file,
                             TextRange rangeToAdjust)
                      throws IncorrectOperationException
```
    Description copied from class: CodeStyleManager
    
    Re-formats the specified range of a file, modifying only line indents and leaving all other whitespace intact.
    
    Specified by:
    
    adjustLineIndent in class CodeStyleManager
    
    Parameters:
    
    file - the file to reformat.
    
    rangeToAdjust - the range of text in which indents should be reformatted.
    
    Throws:
    
    IncorrectOperationException - if the file is read-only.
  - getLineIndent
```
public java.lang.String getLineIndent(PsiFile file,
                                      int offset)
```
    Description copied from class: CodeStyleManager
    
    Calculates the indent that should be used for the specified line in the specified file.
    
    Specified by:
    
    getLineIndent in class CodeStyleManager
    
    Parameters:
    
    file - the file for which the indent should be calculated.
    
    offset - the offset for the line at which the indent should be calculated.
    
    Returns:
    
    the indent string (containing of tabs and/or whitespaces), or null if it was not possible to calculate the indent.
  - getLineIndent
```
public java.lang.String getLineIndent(PsiFile file,
                                      int offset,
                                      FormattingMode mode)
```
    Description copied from class: CodeStyleManager
    
    Calculates the indent that should be used for the specified line in the specified file with the given formatting mode. Default implementation falls back to CodeStyleManager.getLineIndent(PsiFile, int)
    
    Overrides:
    
    getLineIndent in class CodeStyleManager
    
    Parameters:
    
    file - the file for which the indent should be calculated.
    
    offset - the offset for the line at which the indent should be calculated.
    
    mode - the formatting mode FormattingMode
    
    Returns:
    
    the indent string (containing of tabs and/or whitespaces), or null if it was not possible to calculate the indent.
  - getLineIndent
```
public java.lang.String getLineIndent(Document document,
                                      int offset)
```
    Description copied from class: CodeStyleManager
    
    Calculates the indent that should be used for the current line in the specified editor.
    
    Specified by:
    
    getLineIndent in class CodeStyleManager
    
    Parameters:
    
    document - for which the indent should be calculated.
    
    Returns:
    
    the indent string (containing of tabs and/or whitespaces), or null if it was not possible to calculate the indent.
  - isLineToBeIndented
```
@Deprecated
public boolean isLineToBeIndented(PsiFile file,
                                  int offset)
```
    Deprecated.
    
    Specified by:
    
    isLineToBeIndented in class CodeStyleManager
  - insertNewLineIndentMarker
```
public static TextRange insertNewLineIndentMarker(PsiFile file,
                                                  Document document,
                                                  int offset)
```
    Formatter trims line that contains white spaces symbols only, however, there is a possible case that we want to preserve them for particular line (e.g. for live template that defines line with whitespaces that contains $END$ marker: templateText $END$).
    Current approach is to do the following:
```
 
   Insert dummy text at the end of the blank line which white space symbols should be preserved;
   Perform formatting;
   Remove dummy text;
 
 
```
    This method inserts that dummy comment (fallback to identifier xxx, see createDummy(PsiFile)) if necessary.
    Note: it's expected that the whole white space region that contains given offset is processed in a way that all range markers registered for the given offset are expanded to the whole white space region. E.g. there is a possible case that particular range marker serves for defining formatting range, hence, its start/end offsets are updated correspondingly after current method call and whole white space region is reformatted.
    Parameters:
    
    file - target PSI file
    
    document - target document
    
    offset - offset that defines end boundary of the target line text fragment (start boundary is the first line's symbol)
    
    Returns:
    
    text range that points to the newly inserted dummy text if any; null otherwise
    
    Throws:
    
    IncorrectOperationException - if given file is read-only
  - findWhiteSpaceNode
```
public static PsiElement findWhiteSpaceNode(PsiFile file,
                                            int offset)
```
    Allows to check if given offset points to white space element within the given PSI file and return that white space element in the case of positive answer.
    
    Parameters:
    
    file - target file
    
    offset - offset that might point to white space element within the given PSI file
    
    Returns:
    
    target white space element for the given offset within the given file (if any); null otherwise
  - getIndent
```
public Indent getIndent(java.lang.String text,
                        FileType fileType)
```
    Specified by:
    
    getIndent in class CodeStyleManager
  - fillIndent
```
public java.lang.String fillIndent(Indent indent,
                                   FileType fileType)
```
    Specified by:
    
    fillIndent in class CodeStyleManager
  - zeroIndent
```
public Indent zeroIndent()
```
    Specified by:
    
    zeroIndent in class CodeStyleManager
  - isSequentialProcessingAllowed
```
public boolean isSequentialProcessingAllowed()
```
    Description copied from class: CodeStyleManager
    
    Formatting may be executed sequentially, i.e. the whole (re)formatting task is split into a number of smaller sub-tasks that are executed sequentially. That is done primarily for ability to show progress dialog during formatting (formatting is always performed from EDT, hence, the GUI freezes if we perform formatting as a single big iteration).
    However, there are situation when we don't want to use such an approach - for example, the IDE sometimes inserts dummy text into file in order to calculate formatting-specific data and removes it after that. We don't want to allow Swing events dispatching during that in order to not show that dummy text to the end-user.
    It's possible to configure that (implementation details are insignificant here) and current method serves as a read-only facade for obtaining information if 'sequential' processing is allowed at the moment.
    
    Specified by:
    
    isSequentialProcessingAllowed in class CodeStyleManager
    
    Returns:
    
    true if 'sequential' formatting is allowed now; false otherwise
  - setSequentialProcessingAllowed
```
public static void setSequentialProcessingAllowed(boolean allowed)
```
    Allows to define if sequential processing should be allowed.
    Current approach is not allow to stop sequential processing for more than predefine amount of time (couple of seconds). That means that call to this method with 'true' argument is not mandatory for successful processing even if this method is called with 'false' argument before.
    
    Parameters:
    
    allowed - flag that defines if sequential processing should be allowed
  - performActionWithFormatterDisabled
```
public void performActionWithFormatterDisabled(java.lang.Runnable r)
```
    Description copied from class: CodeStyleManager
    
    Disables automatic formatting of modified PSI elements, runs the specified operation and re-enables the formatting. Can be used to improve performance of PSI write operations.
    
    Specified by:
    
    performActionWithFormatterDisabled in class CodeStyleManager
    
    Parameters:
    
    r - the operation to run.
  - performActionWithFormatterDisabled
```
public <T extends java.lang.Throwable> void performActionWithFormatterDisabled(ThrowableRunnable<T> r)
                                                                        throws T extends java.lang.Throwable
```
    Specified by:
    
    performActionWithFormatterDisabled in class CodeStyleManager
    
    Throws:
    
    T extends java.lang.Throwable
  - performActionWithFormatterDisabled
```
public <T> T performActionWithFormatterDisabled(Computable<T> r)
```
    Specified by:
    
    performActionWithFormatterDisabled in class CodeStyleManager
  - getCurrentFormattingMode
```
public FormattingMode getCurrentFormattingMode()
```
    Specified by:
    
    getCurrentFormattingMode in interface FormattingModeAwareIndentAdjuster
  - getSpacing
```
public int getSpacing(PsiFile file,
                      int offset)
```
    Description copied from class: CodeStyleManager
    
    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.
    
    Overrides:
    
    getSpacing in class CodeStyleManager
  - getMinLineFeeds
```
public int getMinLineFeeds(PsiFile file,
                           int offset)
```
    Description copied from class: CodeStyleManager
    
    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.
    
    Overrides:
    
    getMinLineFeeds in class CodeStyleManager
  - runWithDocCommentFormattingDisabled
```
public void runWithDocCommentFormattingDisabled(PsiFile file,
                                                java.lang.Runnable runnable)
```
    Description copied from class: CodeStyleManager
    
    Run the given runnable disabling doc comment formatting.
    
    Overrides:
    
    runWithDocCommentFormattingDisabled in class CodeStyleManager
    
    Parameters:
    
    file - The file for which doc comment formatting should be temporarily disabled.
    
    runnable - The runnable to run.
  - getDocCommentSettings
```
public DocCommentSettings getDocCommentSettings(PsiFile file)
```
    Overrides:
    
    getDocCommentSettings in class CodeStyleManager
  - scheduleIndentAdjustment
```
public void scheduleIndentAdjustment(Document document,
                                     int offset)
```
    Description copied from class: CodeStyleManager
    
    Performs a delayed indent adjustment for large documents bigger than FormatterBasedIndentAdjuster.MAX_SYNCHRONOUS_ADJUSTMENT_DOC_SIZE by scheduling it to a time when the document is committed. Uses formatter to calculate the new indent on a background thread. Only the actual change is done on EDT: the old indent is replaced with a new indent string directly in the document. Doesn't commit the document, thus a subsequent PsiDocumentManager.commitDocument(Document) may be required.
    Note: visually it may lead to a text jump which becomes more obvious, more time it takes to calculate the new indent using a formatting model. A better way to handle large documents is to implement LineIndentProvider returning a non-null value when possible.
    
    Overrides:
    
    scheduleIndentAdjustment in class CodeStyleManager
    
    Parameters:
    
    document - The document to be modified.
    
    offset - The offset in the line whose indent is to be adjusted.

Class CodeStyleManagerImpl

Constructor Summary

Method Summary

Methods inherited from class com.intellij.psi.codeStyle.CodeStyleManager

Methods inherited from class java.lang.Object

Constructor Detail

CodeStyleManagerImpl

Method Detail

getProject

reformat

reformat

reformatRange

reformatRange

reformatText

reformatText

reformatTextWithContext

reformatText

formatRanges

reformatNewlyAddedElement

adjustLineIndent

adjustLineIndent

adjustLineIndent

adjustLineIndent

getLineIndent

getLineIndent

getLineIndent

isLineToBeIndented

insertNewLineIndentMarker

findWhiteSpaceNode

getIndent

fillIndent

zeroIndent

isSequentialProcessingAllowed

setSequentialProcessingAllowed

performActionWithFormatterDisabled

performActionWithFormatterDisabled

performActionWithFormatterDisabled

getCurrentFormattingMode

getSpacing

getMinLineFeeds

runWithDocCommentFormattingDisabled

getDocCommentSettings

scheduleIndentAdjustment