Package com.intellij.psi.codeStyle

Class CodeStyleSettingsProvider

java.lang.Object

com.intellij.psi.codeStyle.CodeStyleSettingsProvider

Direct Known Subclasses:

CodeStyleGroupProvider, GeneralCodeStyleSettingsProvider, GenerationSettingsProvider, GroovyCodeStyleSettingsProvider, GroovyGenerationSettingsProvider, HtmlCodeStyleSettingsProvider, JsonCodeStyleSettingsProvider, LanguageCodeStyleSettingsProvider, OtherFileTypesCodeStyleOptionsProvider, XmlCodeStyleSettingsProvider, YAMLCodeStyleSettingsProvider

public abstract class CodeStyleSettingsProvider
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<CodeStyleSettingsProvider>	EXTENSION_POINT_NAME

Constructor Summary

Constructors

Constructor and Description
CodeStyleSettingsProvider()

Method Summary

Modifier and Type	Method and Description
CodeStyleConfigurable	createConfigurable(CodeStyleSettings settings, CodeStyleSettings modelSettings) Creates a code style configurable.
CustomCodeStyleSettings	createCustomSettings(CodeStyleSettings settings)
Configurable	createSettingsPage(CodeStyleSettings settings, CodeStyleSettings modelSettings) Deprecated. use createConfigurable(CodeStyleSettings, CodeStyleSettings) or LanguageCodeStyleSettingsProvider.createConfigurable(CodeStyleSettings, CodeStyleSettings) for language settings.
java.lang.String	getConfigurableDisplayName() Returns the name of the configurable page without creating a Configurable instance.
CodeStyleGroup	getGroup()
Language	getLanguage() Specifies a language this provider applies to.
DisplayPriority	getPriority()
boolean	hasSettingsPage()

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_POINT_NAME

public static final ExtensionPointName<CodeStyleSettingsProvider> EXTENSION_POINT_NAME

Constructor Detail

CodeStyleSettingsProvider

public CodeStyleSettingsProvider()

Method Detail

createCustomSettings

public CustomCodeStyleSettings createCustomSettings(CodeStyleSettings settings)

createSettingsPage

@Deprecated
public Configurable createSettingsPage(CodeStyleSettings settings,
                                       CodeStyleSettings modelSettings)

Deprecated. use createConfigurable(CodeStyleSettings, CodeStyleSettings) or LanguageCodeStyleSettingsProvider.createConfigurable(CodeStyleSettings, CodeStyleSettings) for language settings.

createConfigurable

public CodeStyleConfigurable createConfigurable(CodeStyleSettings settings,
                                                CodeStyleSettings modelSettings)

Creates a code style configurable. The configurable uses original settings which are eventually changed after a user applies changes and model settings which are immediately modified upon changes in UI.

Parameters:

settings - The original settings.

modelSettings - The model settings.

Returns:

The created code style configurable.

getConfigurableDisplayName

public java.lang.String getConfigurableDisplayName()

Returns the name of the configurable page without creating a Configurable instance.

Returns:

the display name of the configurable page.

hasSettingsPage

public boolean hasSettingsPage()

getPriority

public DisplayPriority getPriority()

getLanguage

public Language getLanguage()

Specifies a language this provider applies to. If the language is not null, its display name will be used as a configurable name by default if getConfigurableDisplayName() is not overridden.

Returns:

null by default.

getGroup

public CodeStyleGroup getGroup()

Returns:

CodeStyleGroup instance if a configurable returned by createConfigurable(CodeStyleSettings, CodeStyleSettings) is a part of a code style group or null if the configurable must be shown directly under "Code Style" settings node.

See Also:

CodeStyleGroup