Package com.intellij.codeStyle

Class CodeStyleFacade

java.lang.Object

com.intellij.codeStyle.CodeStyleFacade

Direct Known Subclasses:

CodeStyleFacadeImpl

public abstract class CodeStyleFacade
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CodeStyleFacade()

Method Summary

Modifier and Type	Method and Description
abstract int	getIndentSize(FileType fileType) Deprecated. Use CodeStyle.getIndentSize(com.intellij.psi.PsiFile) instead.
static CodeStyleFacade	getInstance()
static CodeStyleFacade	getInstance(Project project)
abstract 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.
abstract java.lang.String	getLineIndent(Document document, int offset) Deprecated. Use getLineIndent(Editor, Language, int, boolean) instead.
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.
abstract java.lang.String	getLineSeparator() Deprecated. Use getLineSeparator() method of CodeStyle.getSettings(PsiFile) or CodeStyle.getSettings(Project) if there is no PsiFile
abstract int	getTabSize(FileType fileType) Deprecated. Use CodeStyle.getIndentOptions(PsiFile).TAB_SIZE. See CodeStyle for more information
abstract boolean	useSpaceAfterComma(PsiFile psiFile, Language language) Determines whether a comma after space is needed for given PsiFile in given Language context.
abstract boolean	useSpaceAroundAssignmentOperators(PsiFile psiFile, Language language) Determines whether assignment operator should be surrounded with spaces for given PsiFile in given Language context.
abstract boolean	useSpaceBeforeComma(PsiFile psiFile, Language language) Determines whether a comma before space is needed for given PsiFile in given Language context.
abstract boolean	useTabCharacter(FileType fileType) Deprecated. Use CodeStyle.getIndentOptions(PsiFile).USE_TAB_CHARACTER. See CodeStyle for more information

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeStyleFacade

public CodeStyleFacade()

Method Detail

getInstance

public static CodeStyleFacade getInstance()

getInstance

public static CodeStyleFacade getInstance(Project project)

getLineIndent

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

Deprecated. Use getLineIndent(Editor, Language, int, boolean) instead.

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

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)

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.

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.

getIndentSize

@Deprecated
public abstract int getIndentSize(FileType fileType)

Deprecated. Use CodeStyle.getIndentSize(com.intellij.psi.PsiFile) instead.

getJoinedLinesSpacing

public abstract 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. 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.

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.

getTabSize

@Deprecated
public abstract int getTabSize(FileType fileType)

Deprecated. Use CodeStyle.getIndentOptions(PsiFile).TAB_SIZE. See CodeStyle for more information

useTabCharacter

@Deprecated
public abstract boolean useTabCharacter(FileType fileType)

Deprecated. Use CodeStyle.getIndentOptions(PsiFile).USE_TAB_CHARACTER. See CodeStyle for more information

getLineSeparator

@Deprecated
public abstract java.lang.String getLineSeparator()

Deprecated. Use getLineSeparator() method of CodeStyle.getSettings(PsiFile) or CodeStyle.getSettings(Project) if there is no PsiFile

useSpaceBeforeComma

public abstract boolean useSpaceBeforeComma(PsiFile psiFile,
                                            Language language)

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

Parameters:

psiFile - File to determine settings

language - Context language

Returns:

whether the space before comma is needed

useSpaceAfterComma

public abstract boolean useSpaceAfterComma(PsiFile psiFile,
                                           Language language)

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

Parameters:

psiFile - File to determine settings

language - Context language

Returns:

whether the space after comma is needed

useSpaceAroundAssignmentOperators

public abstract boolean useSpaceAroundAssignmentOperators(PsiFile psiFile,
                                                          Language language)

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

Parameters:

psiFile - File to determine settings

language - Context language

Returns:

whether to surround assignment operator with spaces