Package com.intellij.application.options

Class CodeStyle

java.lang.Object

com.intellij.application.options.CodeStyle

public class CodeStyle
extends java.lang.Object

Utility class for miscellaneous code style settings retrieving methods.

Method Summary

Modifier and Type	Method and Description
static void	doWithTemporarySettings(Project project, CodeStyleSettings tempSettings, java.lang.Runnable runnable) Execute the specified runnable with the given temporary code style settings and restore the old settings even if the runnable fails with an exception.
static void	dropTemporarySettings(Project project) Drop temporary settings.
static <T extends CustomCodeStyleSettings> T	getCustomSettings(PsiFile file, java.lang.Class<T> customSettingsClass) Returns custom settings for the given PSI file.
static CodeStyleSettings	getDefaultSettings()
static CommonCodeStyleSettings.IndentOptions	getIndentOptions(Project project, Document document) Returns indent options for the given project and document.
static CommonCodeStyleSettings.IndentOptions	getIndentOptions(PsiFile file) Returns indent options for the given PSI file.
static CommonCodeStyleSettings.IndentOptions	getIndentOptionsByFileType(Project project, VirtualFile file) Returns indent options by virtual file's type.
static int	getIndentSize(PsiFile file) Returns indent size for the given PSI file.
static CommonCodeStyleSettings	getLanguageSettings(Editor editor) Returns language code style settings for the specified editor.
static CommonCodeStyleSettings	getLanguageSettings(PsiFile file) Returns language settings for the given PSI file.
static CommonCodeStyleSettings	getLanguageSettings(PsiFile file, Language language) Returns language settings for the given PSI file and language.
static CodeStyleSettings	getProjectOrDefaultSettings(Project project) Returns either project settings if the project is not null or default application-wide settings otherwise.
static CodeStyleSettings	getSettings(Editor editor)
static CodeStyleSettings	getSettings(Project project) Returns root code style settings for the given project.
static CodeStyleSettings	getSettings(PsiFile file) Returns root CodeStyleSettings for the given PSI file.
static boolean	isFormattingEnabled(PsiFile file) Checks if the file can be formatted according to code style settings.
static void	reformatWithFileContext(PsiFile fileToReformat, PsiFile contextFile) Reformat the given fileToReformat using code style settings for the contextFile.
static void	setMainProjectSettings(Project project, CodeStyleSettings settings) Assign main project-wide code style settings and force the project to use its own code style instead of a global (application) one.
static void	setTemporarySettings(Project project, CodeStyleSettings settings) Set temporary settings for the project.
static void	updateDocumentIndentOptions(Project project, Document document) Updates document's indent options from indent options providers.
static boolean	usesOwnSettings(Project project)

Methods inherited from class java.lang.Object

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

Method Detail

getDefaultSettings

public static CodeStyleSettings getDefaultSettings()

Returns:

Default application-wide root code style settings.

getSettings

public static CodeStyleSettings getSettings(Project project)

Returns root code style settings for the given project. For configurable language settings use getLanguageSettings(PsiFile) or getLanguageSettings(PsiFile, Language).

Parameters:

project - The project to get code style settings for.

Returns:

The current root code style settings associated with the project.

getProjectOrDefaultSettings

public static CodeStyleSettings getProjectOrDefaultSettings(Project project)

Returns either project settings if the project is not null or default application-wide settings otherwise.

Parameters:

project - The project to return the settings for or null for default settings.

Returns:

Project or default code style settings.

getSettings

public static CodeStyleSettings getSettings(PsiFile file)

Returns root CodeStyleSettings for the given PSI file. In some cases the returned instance may be of TransientCodeStyleSettings class if the original (project) settings are modified for specific PSI file by CodeStyleSettingsModifier extensions. In these cases the returned instance may change upon the next call if some of TransientCodeStyleSettings dependencies become outdated.

A shorter way to get language-specific settings it to use one of the methods getLanguageSettings(PsiFile) or getLanguageSettings(PsiFile, Language).

Parameters:

file - The file to get code style settings for.

Returns:

The current root code style settings associated with the file or default settings if the file is invalid.

getSettings

public static CodeStyleSettings getSettings(Editor editor)

getLanguageSettings

public static CommonCodeStyleSettings getLanguageSettings(Editor editor)

Returns language code style settings for the specified editor. If the editor has an associated document and PSI file, returns settings for the PSI file or null otherwise.

Parameters:

editor - The editor to get settings for.

Returns:

The language code style settings for the editor or null.

getCustomSettings

public static <T extends CustomCodeStyleSettings> T getCustomSettings(PsiFile file,
                                                                      java.lang.Class<T> customSettingsClass)

Returns custom settings for the given PSI file.

Type Parameters:

T - Settings class type.

Parameters:

file - The file.

customSettingsClass - The class of a settings object to be returned.

Returns:

The current custom settings associated with the PSI file.

getLanguageSettings

public static CommonCodeStyleSettings getLanguageSettings(PsiFile file)

Returns language settings for the given PSI file. The language is taken from the file itself.

Parameters:

file - The file to retrieve language settings for.

Returns:

The associated language settings.

getLanguageSettings

public static CommonCodeStyleSettings getLanguageSettings(PsiFile file,
                                                          Language language)

Returns language settings for the given PSI file and language. This method may be useful when PSI file contains elements for multiple languages and language settings should be taken from a specific language context.

Parameters:

file - The file to retrieve language settings for.

Returns:

The associated language settings.

getIndentOptions

public static CommonCodeStyleSettings.IndentOptions getIndentOptions(PsiFile file)

Returns indent options for the given PSI file. The method attempts to use FileIndentOptionsProvider if applicable to the file. If there are no suitable indent options providers, it takes configurable language indent options or retrieves indent options by file type.

Parameters:

file - The file to get indent options for.

Returns:

The file indent options.

See Also:

FileIndentOptionsProvider

getIndentOptionsByFileType

public static CommonCodeStyleSettings.IndentOptions getIndentOptionsByFileType(Project project,
                                                                               VirtualFile file)

Returns indent options by virtual file's type. If null is given instead of the virtual file or the type of the virtual file doesn't have it's own configuration, returns other indent options configured via "Other File Types" section in Settings.

Note: This method is faster then getIndentOptions(PsiFile) but it doesn't take into account possible configurations overwriting the default, for example EditorConfig.

Parameters:

project - The current project.

file - The virtual file to get indent options for or null if the file is unknown.

Returns:

The indent options for the given project and file.

getIndentOptions

public static CommonCodeStyleSettings.IndentOptions getIndentOptions(Project project,
                                                                     Document document)

Returns indent options for the given project and document.

Parameters:

project - The current project.

document - The document to get indent options for.

Returns:

The indent options associated with document's PSI file if the file is available or other indent options otherwise.

getIndentSize

public static int getIndentSize(PsiFile file)

Returns indent size for the given PSI file.

Parameters:

file - The file to get indent size for.

Returns:

The indent size to be used with the PSI file.

setTemporarySettings

public static void setTemporarySettings(Project project,
                                        CodeStyleSettings settings)

Set temporary settings for the project. Temporary settings will override any user settings until dropTemporarySettings(Project) is called.

Note The method is supposed to be used in test's setUp() method. In production code use doWithTemporarySettings(Project, CodeStyleSettings, Runnable).

Parameters:

project - The project or null for default settings.

settings - The settings to use temporarily with the project.

dropTemporarySettings

public static void dropTemporarySettings(Project project)

Drop temporary settings.

Note The method is supposed to be used in test's tearDown() method. In production code use doWithTemporarySettings(Project, CodeStyleSettings, Runnable).

Parameters:

project - The project to drop temporary settings for or null for default settings.

See Also:

setTemporarySettings(Project, CodeStyleSettings)

doWithTemporarySettings

public static void doWithTemporarySettings(Project project,
                                           CodeStyleSettings tempSettings,
                                           java.lang.Runnable runnable)

Execute the specified runnable with the given temporary code style settings and restore the old settings even if the runnable fails with an exception.

Parameters:

project - The current project.

tempSettings - The temporary code style settings.

runnable - The runnable to execute with the temporary settings.

usesOwnSettings

public static boolean usesOwnSettings(Project project)

Parameters:

project - The project to check.

Returns:

true if the project uses its own project code style, false if global (application-level) code style settings are used.

updateDocumentIndentOptions

public static void updateDocumentIndentOptions(Project project,
                                               Document document)

Updates document's indent options from indent options providers.

Note: Calling this method directly when there is an editor associated with the document may cause the editor work incorrectly. To keep consistency with the editor call EditorEx.reinitSettings() instead.

Parameters:

project - The project of the document.

document - The document to update indent options for.

setMainProjectSettings

public static void setMainProjectSettings(Project project,
                                          CodeStyleSettings settings)

Assign main project-wide code style settings and force the project to use its own code style instead of a global (application) one.

Parameters:

project - The project to assign the settings to.

settings - The settings to use with the project.

isFormattingEnabled

public static boolean isFormattingEnabled(PsiFile file)

Checks if the file can be formatted according to code style settings. If formatting is disabled, all related operations including optimize imports and rearrange code should be blocked (cause no changes).

Parameters:

file - The PSI file to check.

Returns:

True if the file is formattable, false otherwise.

reformatWithFileContext

public static void reformatWithFileContext(PsiFile fileToReformat,
                                           PsiFile contextFile)

Reformat the given fileToReformat using code style settings for the contextFile. The method may be useful to reformat a fragment of code (temporary file) which eventually will be inserted to the context file.

Parameters:

fileToReformat - The file to reformat (may be a temporary dummy file).

contextFile - The actual (target) file whose settings must be used.