Package com.intellij.psi.impl.source.codeStyle

Class CodeStyleFacadeImpl

java.lang.Object

com.intellij.codeStyle.CodeStyleFacade

com.intellij.psi.impl.source.codeStyle.CodeStyleFacadeImpl

public class CodeStyleFacadeImpl
extends CodeStyleFacade

Constructor Summary

Constructors

Constructor and Description
CodeStyleFacadeImpl()
CodeStyleFacadeImpl(Project project)

Method Summary

Modifier and Type	Method and Description
int	getIndentSize(FileType fileType) Deprecated.
int	getJoinedLinesSpacing(Editor editor, Language language, int offset, boolean allowDocCommit) Calculates the spacing (in columns) for joined lines at given offset after join lines or smart backspace actions.
java.lang.String	getLineIndent(Document document, int offset) Deprecated.
java.lang.String	getLineIndent(Editor editor, Language language, int offset, boolean allowDocCommit) Calculates the indent that should be used for the line at specified offset in the specified editor.
java.lang.String	getLineSeparator()
int	getTabSize(FileType fileType)
boolean	useSpaceAfterComma(PsiFile psiFile, Language language) Determines whether a comma after space is needed for given PsiFile in given Language context.
boolean	useSpaceAroundAssignmentOperators(PsiFile psiFile, Language language) Determines whether assignment operator should be surrounded with spaces for given PsiFile in given Language context.
boolean	useSpaceBeforeComma(PsiFile psiFile, Language language) Determines whether a comma before space is needed for given PsiFile in given Language context.
boolean	useTabCharacter(FileType fileType)

Methods inherited from class com.intellij.codeStyle.CodeStyleFacade

getInstance, getInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeStyleFacadeImpl

public CodeStyleFacadeImpl()

CodeStyleFacadeImpl

public CodeStyleFacadeImpl(Project project)

Method Detail

getIndentSize

@Deprecated
public int getIndentSize(FileType fileType)

Deprecated.

Specified by:

getIndentSize in class CodeStyleFacade

getLineIndent

@Deprecated
public java.lang.String getLineIndent(Document document,
                                      int offset)

Deprecated.

Description copied from class: CodeStyleFacade

Calculates the indent that should be used for the line at specified offset in the specified document.

Specified by:

getLineIndent in class CodeStyleFacade

Parameters:

document - the document for which the indent should be calculated.

offset - the caret offset in the editor.

Returns:

the indent string (containing of tabs and/or white spaces), or null if it was not possible to calculate the indent.

getLineIndent

public java.lang.String getLineIndent(Editor editor,
                                      Language language,
                                      int offset,
                                      boolean allowDocCommit)

Description copied from class: CodeStyleFacade

Calculates the indent that should be used for the line at specified offset in the specified editor. If there is a suitable LineIndentProvider for the language, it will be used to calculate the indent. Otherwise, if allowDocCommit flag is true, the method will use formatter on committed document.

Overrides:

getLineIndent in class CodeStyleFacade

Parameters:

editor - The editor for which the indent must be returned.

language - Context language

offset - The caret offset in the editor.

allowDocCommit - Allow calculation using committed document.

NOTE: Committing the document may be slow an cause performance issues on large files.

Returns:

the indent string (containing of tabs and/or white spaces), or null if it was not possible to calculate the indent.

getJoinedLinesSpacing

public int getJoinedLinesSpacing(Editor editor,
                                 Language language,
                                 int offset,
                                 boolean allowDocCommit)

Description copied from class: CodeStyleFacade

Calculates the spacing (in columns) for joined lines at given offset after join lines or smart backspace actions. If there is a suitable LineIndentProvider for the language, it will be used to calculate the spacing. Otherwise, if allowDocCommit flag is true, the method will use formatter on committed document.

Specified by:

getJoinedLinesSpacing in class CodeStyleFacade

Parameters:

editor - The editor for which the spacing must be returned.

language - Context language

offset - Offset in the editor after the indent in the second joining line.

allowDocCommit - Allow calculation using committed document.

NOTE: Committing the document may be slow an cause performance issues on large files.

Returns:

non-negative spacing between end- and start-line tokens after the join.

getLineSeparator

public java.lang.String getLineSeparator()

Specified by:

getLineSeparator in class CodeStyleFacade

getTabSize

public int getTabSize(FileType fileType)

Specified by:

getTabSize in class CodeStyleFacade

useTabCharacter

public boolean useTabCharacter(FileType fileType)

Specified by:

useTabCharacter in class CodeStyleFacade

useSpaceBeforeComma

public boolean useSpaceBeforeComma(PsiFile psiFile,
                                   Language language)

Description copied from class: CodeStyleFacade

Determines whether a comma before space is needed for given PsiFile in given Language context.

Specified by:

useSpaceBeforeComma in class CodeStyleFacade

Parameters:

psiFile - File to determine settings

language - Context language

Returns:

whether the space before comma is needed

useSpaceAfterComma

public boolean useSpaceAfterComma(PsiFile psiFile,
                                  Language language)

Description copied from class: CodeStyleFacade

Determines whether a comma after space is needed for given PsiFile in given Language context.

Specified by:

useSpaceAfterComma in class CodeStyleFacade

Parameters:

psiFile - File to determine settings

language - Context language

Returns:

whether the space after comma is needed

useSpaceAroundAssignmentOperators

public boolean useSpaceAroundAssignmentOperators(PsiFile psiFile,
                                                 Language language)

Description copied from class: CodeStyleFacade

Determines whether assignment operator should be surrounded with spaces for given PsiFile in given Language context.

Specified by:

useSpaceAroundAssignmentOperators in class CodeStyleFacade

Parameters:

psiFile - File to determine settings

language - Context language

Returns:

whether to surround assignment operator with spaces