Package com.intellij.psi.codeStyle

Class CodeStyleSettingsManager

java.lang.Object

com.intellij.psi.codeStyle.CodeStyleSettingsManager

All Implemented Interfaces:

PersistentStateComponent<Element>, PersistentStateComponentWithModificationTracker<Element>

Direct Known Subclasses:

AppCodeStyleSettingsManager, ProjectCodeStyleSettingsManager

public class CodeStyleSettingsManager
extends java.lang.Object
implements PersistentStateComponentWithModificationTracker<Element>

Field Summary

Fields

Modifier and Type	Field and Description
CodeStyleSettings	PER_PROJECT_SETTINGS Deprecated. Use setMainProjectCodeStyle(CodeStyleSettings) or getMainProjectCodeStyle() instead
java.lang.String	PREFERRED_PROJECT_CODE_STYLE
boolean	USE_PER_PROJECT_SETTINGS

Constructor Summary

Constructors

Constructor and Description
CodeStyleSettingsManager()

Method Summary

Modifier and Type	Method and Description
void	addListener(CodeStyleSettingsListener listener)
void	dropTemporarySettings()
protected java.util.Collection<CodeStyleSettings>	enumSettings()
void	fireCodeStyleSettingsChanged(PsiFile file)
CodeStyleSettings	getCurrentSettings() Deprecated. see comments for getSettings(Project)
static CodeStyleSettingsManager	getInstance() Deprecated. Use CodeStyle.getDefaultSettings() instead.
static CodeStyleSettingsManager	getInstance(Project project)
CodeStyleSettings	getMainProjectCodeStyle()
static CodeStyleSettings	getSettings(Project project) Deprecated. Use one of the following methods: CodeStyle.getLanguageSettings(PsiFile, Language) to get common settings for a language. CodeStyle.getCustomSettings(PsiFile, Class) to get custom settings. If PsiFile is not applicable, use CodeStyle.getSettings(Project) but only in cases when using main project settings is logically the only choice in a given context. It shouldn't be used just because the existing code doesn't allow to easily retrieve a PsiFile. Otherwise the code will not catch up with proper file code style settings since the settings may differ for different files depending on their scope.
Element	getState()
long	getStateModificationCount()
CodeStyleSettings	getTemporarySettings()
protected boolean	isIgnoredOnSave(java.lang.String fieldName)
boolean	isLoaded() Deprecated. unused
void	loadState(Element state) This method is called when new component state is loaded.
void	notifyCodeStyleSettingsChanged() Increase current project's code style modification tracker and notify all the listeners on changed code style.
void	registerCustomSettings(java.util.Collection<CodeStyleSettings> allSettings, CodeStyleSettingsProvider provider)
protected void	registerExtensionPointListeners(Disposable disposable)
void	registerFileTypeIndentOptions(java.util.Collection<CodeStyleSettings> allSettings, FileType fileType, CommonCodeStyleSettings.IndentOptions indentOptions)
void	registerLanguageSettings(java.util.Collection<CodeStyleSettings> allSettings, LanguageCodeStyleSettingsProvider provider)
static void	removeListener(Project project, CodeStyleSettingsListener listener)
void	setMainProjectCodeStyle(CodeStyleSettings settings) Sets main project settings by the name "Project".
void	setTemporarySettings(CodeStyleSettings settings)
void	unregisterCustomSettings(java.util.Collection<CodeStyleSettings> allSettings, CodeStyleSettingsProvider provider)
void	unregisterFileTypeIndentOptions(java.util.Collection<CodeStyleSettings> allSettings, FileType fileType)
void	unregisterLanguageSettings(java.util.Collection<CodeStyleSettings> allSettings, LanguageCodeStyleSettingsProvider provider)
void	updateSettingsTracker()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.components.PersistentStateComponent

initializeComponent, noStateLoaded

Field Detail

PER_PROJECT_SETTINGS

@Deprecated
public volatile CodeStyleSettings PER_PROJECT_SETTINGS

Deprecated. Use setMainProjectCodeStyle(CodeStyleSettings) or getMainProjectCodeStyle() instead

USE_PER_PROJECT_SETTINGS

public volatile boolean USE_PER_PROJECT_SETTINGS

PREFERRED_PROJECT_CODE_STYLE

public volatile java.lang.String PREFERRED_PROJECT_CODE_STYLE

Constructor Detail

CodeStyleSettingsManager

public CodeStyleSettingsManager()

Method Detail

getStateModificationCount

public long getStateModificationCount()

Specified by:

getStateModificationCount in interface PersistentStateComponentWithModificationTracker<Element>

getInstance

public static CodeStyleSettingsManager getInstance(Project project)

getInstance

@Deprecated
public static CodeStyleSettingsManager getInstance()

Deprecated. Use CodeStyle.getDefaultSettings() instead.

registerExtensionPointListeners

protected void registerExtensionPointListeners(Disposable disposable)

enumSettings

protected java.util.Collection<CodeStyleSettings> enumSettings()

registerFileTypeIndentOptions

public final void registerFileTypeIndentOptions(java.util.Collection<CodeStyleSettings> allSettings,
                                                FileType fileType,
                                                CommonCodeStyleSettings.IndentOptions indentOptions)

unregisterFileTypeIndentOptions

public final void unregisterFileTypeIndentOptions(java.util.Collection<CodeStyleSettings> allSettings,
                                                  FileType fileType)

registerLanguageSettings

public final void registerLanguageSettings(java.util.Collection<CodeStyleSettings> allSettings,
                                           LanguageCodeStyleSettingsProvider provider)

unregisterLanguageSettings

public final void unregisterLanguageSettings(java.util.Collection<CodeStyleSettings> allSettings,
                                             LanguageCodeStyleSettingsProvider provider)

registerCustomSettings

public final void registerCustomSettings(java.util.Collection<CodeStyleSettings> allSettings,
                                         CodeStyleSettingsProvider provider)

unregisterCustomSettings

public final void unregisterCustomSettings(java.util.Collection<CodeStyleSettings> allSettings,
                                           CodeStyleSettingsProvider provider)

getSettings

@Deprecated
public static CodeStyleSettings getSettings(Project project)

Deprecated. Use one of the following methods:

• CodeStyle.getLanguageSettings(PsiFile, Language) to get common settings for a language.
• CodeStyle.getCustomSettings(PsiFile, Class) to get custom settings.

If PsiFile is not applicable, use CodeStyle.getSettings(Project) but only in cases when using main project settings is logically the only choice in a given context. It shouldn't be used just because the existing code doesn't allow to easily retrieve a PsiFile. Otherwise the code will not catch up with proper file code style settings since the settings may differ for different files depending on their scope.

getCurrentSettings

@Deprecated
public CodeStyleSettings getCurrentSettings()

Deprecated. see comments for getSettings(Project)

getState

public Element getState()

Specified by:

getState in interface PersistentStateComponent<Element>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

isIgnoredOnSave

protected boolean isIgnoredOnSave(java.lang.String fieldName)

loadState

public void loadState(Element state)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<Element>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

setMainProjectCodeStyle

public void setMainProjectCodeStyle(CodeStyleSettings settings)

Sets main project settings by the name "Project". For default project it's the only named code style.

Parameters:

settings - The code style settings which can be assigned to project.

getMainProjectCodeStyle

public CodeStyleSettings getMainProjectCodeStyle()

Returns:

The main project code style settings. For default project, that's the only code style.

isLoaded

@Deprecated
public boolean isLoaded()

Deprecated. unused

setTemporarySettings

public void setTemporarySettings(CodeStyleSettings settings)

See Also:

dropTemporarySettings()

dropTemporarySettings

public void dropTemporarySettings()

getTemporarySettings

public CodeStyleSettings getTemporarySettings()

addListener

public void addListener(CodeStyleSettingsListener listener)

removeListener

public static void removeListener(Project project,
                                  CodeStyleSettingsListener listener)

fireCodeStyleSettingsChanged

public void fireCodeStyleSettingsChanged(PsiFile file)

notifyCodeStyleSettingsChanged

public final void notifyCodeStyleSettingsChanged()

Increase current project's code style modification tracker and notify all the listeners on changed code style. The method must be called if project code style is changed programmatically so that editors and etc. are aware of code style update and refresh their settings accordingly.

See Also:

CodeStyleSettingsListener, addListener(CodeStyleSettingsListener)

updateSettingsTracker

public void updateSettingsTracker()