Package com.intellij.ide

Class JavaLanguageCodeStyleSettingsProvider

java.lang.Object

com.intellij.psi.codeStyle.CodeStyleSettingsProvider

com.intellij.psi.codeStyle.LanguageCodeStyleSettingsProvider

com.intellij.ide.JavaLanguageCodeStyleSettingsProvider

public class JavaLanguageCodeStyleSettingsProvider
extends LanguageCodeStyleSettingsProvider

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.psi.codeStyle.LanguageCodeStyleSettingsProvider

LanguageCodeStyleSettingsProvider.SettingsType

Field Summary

Fields inherited from class com.intellij.psi.codeStyle.LanguageCodeStyleSettingsProvider

EP_NAME

Fields inherited from class com.intellij.psi.codeStyle.CodeStyleSettingsProvider

EXTENSION_POINT_NAME

Constructor Summary

Constructors

Constructor and Description
JavaLanguageCodeStyleSettingsProvider()

Method Summary

Modifier and Type	Method and Description
CodeStyleConfigurable	createConfigurable(CodeStyleSettings settings, CodeStyleSettings modelSettings) Create a code style configurable for the given base settings and model settings.
CustomCodeStyleSettings	createCustomSettings(CodeStyleSettings settings)
PsiFile	createFileFromText(Project project, java.lang.String text) Allows to customize PSI file creation for a language settings preview panel.
void	customizeSettings(CodeStyleSettingsCustomizable consumer, LanguageCodeStyleSettingsProvider.SettingsType settingsType)
CodeStyleFieldAccessor	getAccessor(java.lang.Object codeStyleObject, java.lang.reflect.Field field)
java.util.List<CodeStylePropertyAccessor>	getAdditionalAccessors(java.lang.Object codeStyleObject)
java.lang.String	getCodeSample(LanguageCodeStyleSettingsProvider.SettingsType settingsType)
DocCommentSettings	getDocCommentSettings(CodeStyleSettings rootSettings) Returns a wrapper around language's own code documentation comment settings from the given rootSettings.
IndentOptionsEditor	getIndentOptionsEditor()
Language	getLanguage() Specifies a language this provider applies to.
int	getRightMargin(LanguageCodeStyleSettingsProvider.SettingsType settingsType)

Methods inherited from class com.intellij.psi.codeStyle.LanguageCodeStyleSettingsProvider

calcSettingPagesProviders, createFileFromText, customizeDefaults, findUsingBaseLanguage, forLanguage, getApplicableLanguages, getCodeSample, getDefaultCommonSettings, getDefaultCommonSettings, getDisplayPriority, getDisplayPriority, getExternalLanguageId, getFileExt, getFileExt, getLanguage, getLanguageName, getLanguageName, getLanguagesWithCodeStyleSettings, getPredefinedCodeStyles, getPropertyMapper, getRightMargin, getSettingsPagesProviders, getSupportedFields, getSupportedFields, resetSettingsPagesProviders, supportsExternalFormats

Methods inherited from class com.intellij.psi.codeStyle.CodeStyleSettingsProvider

createSettingsPage, getConfigurableDisplayName, getGroup, getPriority, hasSettingsPage

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaLanguageCodeStyleSettingsProvider

public JavaLanguageCodeStyleSettingsProvider()

Method Detail

createConfigurable

public CodeStyleConfigurable createConfigurable(CodeStyleSettings settings,
                                                CodeStyleSettings modelSettings)

Description copied from class: LanguageCodeStyleSettingsProvider

Create a code style configurable for the given base settings and model settings.

Overrides:

createConfigurable in class LanguageCodeStyleSettingsProvider

Parameters:

settings - The base (initial) settings before changes.

modelSettings - The settings to which UI changes are applied.

Returns:

The code style configurable.

See Also:

CodeStyleConfigurable

createCustomSettings

public CustomCodeStyleSettings createCustomSettings(CodeStyleSettings settings)

Overrides:

createCustomSettings in class CodeStyleSettingsProvider

getLanguage

public Language getLanguage()

Description copied from class: CodeStyleSettingsProvider

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.

Specified by:

getLanguage in class LanguageCodeStyleSettingsProvider

Returns:

null by default.

getCodeSample

public java.lang.String getCodeSample(LanguageCodeStyleSettingsProvider.SettingsType settingsType)

Specified by:

getCodeSample in class LanguageCodeStyleSettingsProvider

getRightMargin

public int getRightMargin(LanguageCodeStyleSettingsProvider.SettingsType settingsType)

Overrides:

getRightMargin in class LanguageCodeStyleSettingsProvider

customizeSettings

public void customizeSettings(CodeStyleSettingsCustomizable consumer,
                              LanguageCodeStyleSettingsProvider.SettingsType settingsType)

Overrides:

customizeSettings in class LanguageCodeStyleSettingsProvider

createFileFromText

public PsiFile createFileFromText(Project project,
                                  java.lang.String text)

Description copied from class: LanguageCodeStyleSettingsProvider

Allows to customize PSI file creation for a language settings preview panel.

IMPORTANT: The created file must be a non-physical one with PSI events disabled. For more information see PsiFileFactory.createFileFromText(String, Language, CharSequence, boolean, boolean) where eventSystemEnabled parameter must be false

Overrides:

createFileFromText in class LanguageCodeStyleSettingsProvider

Parameters:

project - current project

text - code sample to demonstrate formatting settings (see LanguageCodeStyleSettingsProvider.getCodeSample(LanguageCodeStyleSettingsProvider.SettingsType)

Returns:

a PSI file instance with given text, or null for default implementation using provider's language.

getIndentOptionsEditor

public IndentOptionsEditor getIndentOptionsEditor()

Overrides:

getIndentOptionsEditor in class LanguageCodeStyleSettingsProvider

getDocCommentSettings

public DocCommentSettings getDocCommentSettings(CodeStyleSettings rootSettings)

Description copied from class: LanguageCodeStyleSettingsProvider

Returns a wrapper around language's own code documentation comment settings from the given rootSettings.

Overrides:

getDocCommentSettings in class LanguageCodeStyleSettingsProvider

Parameters:

rootSettings - Root code style setting to retrieve doc comment settings from.

Returns:

DocCommentSettings wrapper object object which allows to retrieve and modify language's own settings related to doc comment. The object is used then by common platform doc comment handling algorithms.

getAccessor

public CodeStyleFieldAccessor getAccessor(java.lang.Object codeStyleObject,
                                          java.lang.reflect.Field field)

Overrides:

getAccessor in class LanguageCodeStyleSettingsProvider

getAdditionalAccessors

public java.util.List<CodeStylePropertyAccessor> getAdditionalAccessors(java.lang.Object codeStyleObject)

Overrides:

getAdditionalAccessors in class LanguageCodeStyleSettingsProvider