Package com.intellij.psi.codeStyle

Class CodeStyleSettings

java.lang.Object

com.intellij.psi.codeStyle.CommonCodeStyleSettings

com.intellij.psi.codeStyle.LegacyCodeStyleSettings

com.intellij.psi.codeStyle.CodeStyleSettings

All Implemented Interfaces:

JDOMExternalizable, ImportsLayoutSettings, java.lang.Cloneable

Direct Known Subclasses:

CodeStyleSchemesModel.ModelSettings, TransientCodeStyleSettings

public class CodeStyleSettings
extends LegacyCodeStyleSettings
implements java.lang.Cloneable, JDOMExternalizable, ImportsLayoutSettings

A container for global, language and custom code style settings and indent options. Global options are default options for multiple languages and language-independent settings. Global (default) options which may be overwritten by a specific language can be retrieved using getDefault...() methods. Use getCommonSettings(Language) to retrieve code style options for a language. Some languages may have specific options which are stored in a class derived from CustomCodeStyleSettings. Use getCustomSettings(Class) to access them. For indent options use one of getIndentOptions(...) methods. In most cases you need getIndentOptionsByFile(PsiFile).

Consider also using an utility CodeStyle class which encapsulates the above methods where possible.

Note: A direct use of any non-final public fields from CodeStyleSettings class is strongly discouraged. These fields, as well as the inheritance from CommonCodeStyleSettings, are left only for backwards compatibility and may be removed in the future.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodeStyleSettings.HtmlTagNewLineStyle
static class	CodeStyleSettings.QuoteStyle

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

CommonCodeStyleSettings.BraceStyleConstant, CommonCodeStyleSettings.ForceBraceConstant, CommonCodeStyleSettings.IndentOptions, CommonCodeStyleSettings.WrapConstant, CommonCodeStyleSettings.WrapOnTyping

Field Summary

Fields

Modifier and Type	Field and Description
boolean	AUTODETECT_INDENTS
int	CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND Deprecated. Use {@link com.intellij.psi.codeStyle.JavaCodeStyleSettings#CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND
int	CONSTRUCTORS_ORDER_WEIGHT Deprecated.
static int	CURR_VERSION
boolean	ENABLE_JAVADOC_FORMATTING Deprecated. Use JavaCodeStyleSettings.ENABLE_JAVADOC_FORMATTING
java.lang.String	FIELD_NAME_PREFIX Deprecated. Use JavaCodeStyleSettings.FIELD_NAME_PREFIX
java.lang.String	FIELD_NAME_SUFFIX Deprecated. Use JavaCodeStyleSettings.FIELD_NAME_SUFFIX
int	FIELDS_ORDER_WEIGHT Deprecated.
java.lang.String	FORMATTER_OFF_TAG
java.lang.String	FORMATTER_ON_TAG
boolean	FORMATTER_TAGS_ACCEPT_REGEXP
boolean	FORMATTER_TAGS_ENABLED
boolean	GENERATE_FINAL_LOCALS Deprecated. Use JavaCodeStyleSettings.GENERATE_FINAL_LOCALS
boolean	GENERATE_FINAL_PARAMETERS Deprecated. Use JavaCodeStyleSettings.GENERATE_FINAL_PARAMETERS
boolean	HTML_ALIGN_ATTRIBUTES Deprecated. Use HtmlCodeStyleSettings
boolean	HTML_ALIGN_TEXT Deprecated. Use HtmlCodeStyleSettings
int	HTML_ATTRIBUTE_WRAP Deprecated. Use HtmlCodeStyleSettings
int	HTML_DO_NOT_ALIGN_CHILDREN_OF_MIN_LINES Deprecated. Use HtmlCodeStyleSettings
java.lang.String	HTML_DO_NOT_INDENT_CHILDREN_OF Deprecated. Use HtmlCodeStyleSettings
java.lang.String	HTML_DONT_ADD_BREAKS_IF_INLINE_CONTENT Deprecated. Use HtmlCodeStyleSettings
java.lang.String	HTML_ELEMENTS_TO_INSERT_NEW_LINE_BEFORE Deprecated. Use HtmlCodeStyleSettings
java.lang.String	HTML_ELEMENTS_TO_REMOVE_NEW_LINE_BEFORE Deprecated. Use HtmlCodeStyleSettings
boolean	HTML_ENFORCE_QUOTES Deprecated. Use HtmlCodeStyleSettings
java.lang.String	HTML_INLINE_ELEMENTS Deprecated. Use HtmlCodeStyleSettings
int	HTML_KEEP_BLANK_LINES Deprecated. Use HtmlCodeStyleSettings
boolean	HTML_KEEP_LINE_BREAKS Deprecated. Use HtmlCodeStyleSettings
boolean	HTML_KEEP_LINE_BREAKS_IN_TEXT Deprecated. Use HtmlCodeStyleSettings
boolean	HTML_KEEP_WHITESPACES Deprecated. Use HtmlCodeStyleSettings
java.lang.String	HTML_KEEP_WHITESPACES_INSIDE Deprecated. Use HtmlCodeStyleSettings
CodeStyleSettings.HtmlTagNewLineStyle	HTML_NEWLINE_AFTER_LAST_ATTRIBUTE Deprecated. Use HtmlCodeStyleSettings
CodeStyleSettings.HtmlTagNewLineStyle	HTML_NEWLINE_BEFORE_FIRST_ATTRIBUTE Deprecated. Use HtmlCodeStyleSettings
CodeStyleSettings.QuoteStyle	HTML_QUOTE_STYLE Deprecated. Use HtmlCodeStyleSettings
boolean	HTML_SPACE_AFTER_TAG_NAME Deprecated. Use HtmlCodeStyleSettings
boolean	HTML_SPACE_AROUND_EQUALITY_IN_ATTRINUTE Deprecated. Use HtmlCodeStyleSettings
boolean	HTML_SPACE_INSIDE_EMPTY_TAG Deprecated. Use HtmlCodeStyleSettings
int	HTML_TEXT_WRAP Deprecated. Use HtmlCodeStyleSettings
boolean	IGNORE_SAME_INDENTS_FOR_LANGUAGES
PackageEntryTable	IMPORT_LAYOUT_TABLE Deprecated. Use {@link com.intellij.psi.codeStyle.JavaCodeStyleSettings#IMPORT_LAYOUT_TABLE
int	INNER_CLASSES_ORDER_WEIGHT Deprecated.
boolean	INSERT_INNER_CLASS_IMPORTS Deprecated. Use {@link com.intellij.psi.codeStyle.JavaCodeStyleSettings#INSERT_INNER_CLASS_IMPORTS
boolean	INSERT_OVERRIDE_ANNOTATION Deprecated. Use JavaCodeStyleSettings.INSERT_OVERRIDE_ANNOTATION
boolean	JD_LEADING_ASTERISKS_ARE_ENABLED Deprecated. Use JavaCodeStyleSettings.JD_LEADING_ASTERISKS_ARE_ENABLED
boolean	JSP_PREFER_COMMA_SEPARATED_IMPORT_LIST Deprecated. Use com.intellij.application.options.JspCodeStyleSettings#JSP_PREFER_COMMA_SEPARATED_IMPORT_LIST
boolean	LAYOUT_STATIC_IMPORTS_SEPARATELY Deprecated. Use JavaCodeStyleSettings.LAYOUT_STATIC_IMPORTS_SEPARATELY
java.lang.String	LINE_SEPARATOR Line separator.
java.lang.String	LOCAL_VARIABLE_NAME_PREFIX Deprecated. Use JavaCodeStyleSettings.LOCAL_VARIABLE_NAME_PREFIX
java.lang.String	LOCAL_VARIABLE_NAME_SUFFIX Deprecated. Use JavaCodeStyleSettings.LOCAL_VARIABLE_NAME_SUFFIX
int	METHODS_ORDER_WEIGHT Deprecated.
int	NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND Deprecated. Use {@link com.intellij.psi.codeStyle.JavaCodeStyleSettings#NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND
CommonCodeStyleSettings.IndentOptions	OTHER_INDENT_OPTIONS
PackageEntryTable	PACKAGES_TO_USE_IMPORT_ON_DEMAND Deprecated. Use {@link com.intellij.psi.codeStyle.JavaCodeStyleSettings#PACKAGES_TO_USE_IMPORT_ON_DEMAND
java.lang.String	PARAMETER_NAME_PREFIX Deprecated. Use JavaCodeStyleSettings.PARAMETER_NAME_PREFIX
java.lang.String	PARAMETER_NAME_SUFFIX Deprecated. Use JavaCodeStyleSettings.PARAMETER_NAME_SUFFIX
boolean	PARENTHESES_AROUND_METHOD_ARGUMENTS Deprecated. Use RubyCodeStyleSettings.PARENTHESES_AROUND_METHOD_ARGUMENTS
boolean	PREFER_LONGER_NAMES Deprecated. Use JavaCodeStyleSettings.PREFER_LONGER_NAMES
boolean	REPEAT_SYNCHRONIZED Deprecated. Use JavaCodeStyleSettings.REPEAT_SYNCHRONIZED
int	RIGHT_MARGIN
java.lang.String	STATIC_FIELD_NAME_PREFIX Deprecated. Use JavaCodeStyleSettings.STATIC_FIELD_NAME_PREFIX
java.lang.String	STATIC_FIELD_NAME_SUFFIX Deprecated. Use JavaCodeStyleSettings.STATIC_FIELD_NAME_SUFFIX
int	STATIC_FIELDS_ORDER_WEIGHT Deprecated.
int	STATIC_INNER_CLASSES_ORDER_WEIGHT Deprecated.
int	STATIC_METHODS_ORDER_WEIGHT Deprecated.
boolean	USE_EXTERNAL_ANNOTATIONS Deprecated. Use JavaCodeStyleSettings.USE_EXTERNAL_ANNOTATIONS
boolean	USE_FQ_CLASS_NAMES Deprecated. Use JavaCodeStyleSettings.USE_FQ_CLASS_NAMES
boolean	USE_FQ_CLASS_NAMES_IN_JAVADOC Deprecated. use JavaCodeStyleSettings.CLASS_NAMES_IN_JAVADOC instead
boolean	USE_SAME_INDENTS
boolean	USE_SINGLE_CLASS_IMPORTS Deprecated. Use {@link com.intellij.psi.codeStyle.JavaCodeStyleSettings#USE_SINGLE_CLASS_IMPORTS
static java.lang.String	VERSION_ATTR
java.lang.String	VISIBILITY Deprecated. Use JavaCodeStyleSettings.VISIBILITY
boolean	WRAP_WHEN_TYPING_REACHES_RIGHT_MARGIN Do not use this field directly since it doesn't reflect a setting for a specific language which may overwrite this one.

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

ALIGN_CONSECUTIVE_VARIABLE_DECLARATIONS, ALIGN_GROUP_FIELD_DECLARATIONS, ALIGN_MULTILINE_ARRAY_INITIALIZER_EXPRESSION, ALIGN_MULTILINE_ASSIGNMENT, ALIGN_MULTILINE_BINARY_OPERATION, ALIGN_MULTILINE_CHAINED_METHODS, ALIGN_MULTILINE_EXTENDS_LIST, ALIGN_MULTILINE_FOR, ALIGN_MULTILINE_METHOD_BRACKETS, ALIGN_MULTILINE_PARAMETERS, ALIGN_MULTILINE_PARAMETERS_IN_CALLS, ALIGN_MULTILINE_PARENTHESIZED_EXPRESSION, ALIGN_MULTILINE_RESOURCES, ALIGN_MULTILINE_TERNARY_OPERATION, ALIGN_MULTILINE_THROWS_LIST, ALIGN_SUBSEQUENT_SIMPLE_METHODS, ALIGN_THROWS_KEYWORD, ARRAY_INITIALIZER_LBRACE_ON_NEXT_LINE, ARRAY_INITIALIZER_RBRACE_ON_NEXT_LINE, ARRAY_INITIALIZER_WRAP, ASSERT_STATEMENT_COLON_ON_NEXT_LINE, ASSERT_STATEMENT_WRAP, ASSIGNMENT_WRAP, BINARY_OPERATION_SIGN_ON_NEXT_LINE, BINARY_OPERATION_WRAP, BLANK_LINES_AFTER_ANONYMOUS_CLASS_HEADER, BLANK_LINES_AFTER_CLASS_HEADER, BLANK_LINES_AFTER_IMPORTS, BLANK_LINES_AFTER_PACKAGE, BLANK_LINES_AROUND_CLASS, BLANK_LINES_AROUND_FIELD, BLANK_LINES_AROUND_FIELD_IN_INTERFACE, BLANK_LINES_AROUND_METHOD, BLANK_LINES_AROUND_METHOD_IN_INTERFACE, BLANK_LINES_BEFORE_IMPORTS, BLANK_LINES_BEFORE_METHOD_BODY, BLANK_LINES_BEFORE_PACKAGE, BLOCK_COMMENT_AT_FIRST_COLUMN, CALL_PARAMETERS_LPAREN_ON_NEXT_LINE, CALL_PARAMETERS_RPAREN_ON_NEXT_LINE, CALL_PARAMETERS_WRAP, CASE_STATEMENT_ON_NEW_LINE, CATCH_ON_NEW_LINE, CLASS_ANNOTATION_WRAP, DO_NOT_INDENT_TOP_LEVEL_CLASS_MEMBERS, DOWHILE_BRACE_FORCE, ELSE_ON_NEW_LINE, ENUM_CONSTANTS_WRAP, EXTENDS_KEYWORD_WRAP, EXTENDS_LIST_WRAP, FIELD_ANNOTATION_WRAP, FINALLY_ON_NEW_LINE, FOR_BRACE_FORCE, FOR_STATEMENT_LPAREN_ON_NEXT_LINE, FOR_STATEMENT_RPAREN_ON_NEXT_LINE, FOR_STATEMENT_WRAP, FORCE_REARRANGE_MODE, IF_BRACE_FORCE, INDENT_BREAK_FROM_CASE, INDENT_CASE_FROM_SWITCH, KEEP_BLANK_LINES_BEFORE_RBRACE, KEEP_BLANK_LINES_IN_CODE, KEEP_BLANK_LINES_IN_DECLARATIONS, KEEP_CONTROL_STATEMENT_IN_ONE_LINE, KEEP_FIRST_COLUMN_COMMENT, KEEP_LINE_BREAKS, KEEP_MULTIPLE_EXPRESSIONS_IN_ONE_LINE, KEEP_SIMPLE_BLOCKS_IN_ONE_LINE, KEEP_SIMPLE_CLASSES_IN_ONE_LINE, KEEP_SIMPLE_LAMBDAS_IN_ONE_LINE, KEEP_SIMPLE_METHODS_IN_ONE_LINE, LABELED_STATEMENT_WRAP, LINE_COMMENT_ADD_SPACE, LINE_COMMENT_AT_FIRST_COLUMN, METHOD_ANNOTATION_WRAP, METHOD_CALL_CHAIN_WRAP, METHOD_PARAMETERS_LPAREN_ON_NEXT_LINE, METHOD_PARAMETERS_RPAREN_ON_NEXT_LINE, METHOD_PARAMETERS_WRAP, MODIFIER_LIST_WRAP, PARAMETER_ANNOTATION_WRAP, PARENTHESES_EXPRESSION_LPAREN_WRAP, PARENTHESES_EXPRESSION_RPAREN_WRAP, PLACE_ASSIGNMENT_SIGN_ON_NEXT_LINE, PREFER_PARAMETERS_WRAP, RESOURCE_LIST_LPAREN_ON_NEXT_LINE, RESOURCE_LIST_RPAREN_ON_NEXT_LINE, RESOURCE_LIST_WRAP, SPACE_AFTER_COLON, SPACE_AFTER_COMMA, SPACE_AFTER_COMMA_IN_TYPE_ARGUMENTS, SPACE_AFTER_QUEST, SPACE_AFTER_SEMICOLON, SPACE_AFTER_TYPE_CAST, SPACE_AROUND_ADDITIVE_OPERATORS, SPACE_AROUND_ASSIGNMENT_OPERATORS, SPACE_AROUND_BITWISE_OPERATORS, SPACE_AROUND_EQUALITY_OPERATORS, SPACE_AROUND_LAMBDA_ARROW, SPACE_AROUND_LOGICAL_OPERATORS, SPACE_AROUND_METHOD_REF_DBL_COLON, SPACE_AROUND_MULTIPLICATIVE_OPERATORS, SPACE_AROUND_RELATIONAL_OPERATORS, SPACE_AROUND_SHIFT_OPERATORS, SPACE_AROUND_UNARY_OPERATOR, SPACE_BEFORE_ANNOTATION_ARRAY_INITIALIZER_LBRACE, SPACE_BEFORE_ANOTATION_PARAMETER_LIST, SPACE_BEFORE_ARRAY_INITIALIZER_LBRACE, SPACE_BEFORE_CATCH_KEYWORD, SPACE_BEFORE_CATCH_LBRACE, SPACE_BEFORE_CATCH_PARENTHESES, SPACE_BEFORE_CLASS_LBRACE, SPACE_BEFORE_COLON, SPACE_BEFORE_COMMA, SPACE_BEFORE_DO_LBRACE, SPACE_BEFORE_ELSE_KEYWORD, SPACE_BEFORE_ELSE_LBRACE, SPACE_BEFORE_FINALLY_KEYWORD, SPACE_BEFORE_FINALLY_LBRACE, SPACE_BEFORE_FOR_LBRACE, SPACE_BEFORE_FOR_PARENTHESES, SPACE_BEFORE_IF_LBRACE, SPACE_BEFORE_IF_PARENTHESES, SPACE_BEFORE_METHOD_CALL_PARENTHESES, SPACE_BEFORE_METHOD_LBRACE, SPACE_BEFORE_METHOD_PARENTHESES, SPACE_BEFORE_QUEST, SPACE_BEFORE_SEMICOLON, SPACE_BEFORE_SWITCH_LBRACE, SPACE_BEFORE_SWITCH_PARENTHESES, SPACE_BEFORE_SYNCHRONIZED_LBRACE, SPACE_BEFORE_SYNCHRONIZED_PARENTHESES, SPACE_BEFORE_TRY_LBRACE, SPACE_BEFORE_TRY_PARENTHESES, SPACE_BEFORE_TYPE_PARAMETER_LIST, SPACE_BEFORE_WHILE_KEYWORD, SPACE_BEFORE_WHILE_LBRACE, SPACE_BEFORE_WHILE_PARENTHESES, SPACE_WITHIN_ANNOTATION_PARENTHESES, SPACE_WITHIN_ARRAY_INITIALIZER_BRACES, SPACE_WITHIN_BRACES, SPACE_WITHIN_BRACKETS, SPACE_WITHIN_CAST_PARENTHESES, SPACE_WITHIN_CATCH_PARENTHESES, SPACE_WITHIN_EMPTY_ARRAY_INITIALIZER_BRACES, SPACE_WITHIN_EMPTY_METHOD_CALL_PARENTHESES, SPACE_WITHIN_EMPTY_METHOD_PARENTHESES, SPACE_WITHIN_FOR_PARENTHESES, SPACE_WITHIN_IF_PARENTHESES, SPACE_WITHIN_METHOD_CALL_PARENTHESES, SPACE_WITHIN_METHOD_PARENTHESES, SPACE_WITHIN_PARENTHESES, SPACE_WITHIN_SWITCH_PARENTHESES, SPACE_WITHIN_SYNCHRONIZED_PARENTHESES, SPACE_WITHIN_TRY_PARENTHESES, SPACE_WITHIN_WHILE_PARENTHESES, SPECIAL_ELSE_IF_TREATMENT, TERNARY_OPERATION_SIGNS_ON_NEXT_LINE, TERNARY_OPERATION_WRAP, THROWS_KEYWORD_WRAP, THROWS_LIST_WRAP, USE_FLYING_GEESE_BRACES, VARIABLE_ANNOTATION_WRAP, WHILE_BRACE_FORCE, WHILE_ON_NEW_LINE, WRAP_COMMENTS, WRAP_FIRST_METHOD_IN_CALL_CHAIN, WRAP_LONG_LINES, WRAP_ON_TYPING

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

ALIGN_CONSECUTIVE_ASSIGNMENTS, BLANK_LINES_BEFORE_CLASS_END, BRACE_STYLE, CLASS_BRACE_STYLE, DO_NOT_FORCE, DO_NOT_WRAP, END_OF_LINE, FORCE_BRACES_ALWAYS, FORCE_BRACES_IF_MULTILINE, KEEP_BLANK_LINES_BETWEEN_PACKAGE_DECLARATION_AND_HEADER, LAMBDA_BRACE_STYLE, METHOD_BRACE_STYLE, NEXT_LINE, NEXT_LINE_IF_WRAPPED, NEXT_LINE_SHIFTED, NEXT_LINE_SHIFTED2, REARRANGE_ACCORDIND_TO_DIALOG, REARRANGE_ALWAYS, REARRANGE_NEVER, WRAP_ALWAYS, WRAP_AS_NEEDED, WRAP_ON_EVERY_ITEM

Constructor Summary

Constructors

Constructor and Description
CodeStyleSettings()
CodeStyleSettings(boolean loadExtensions)

Method Summary

Modifier and Type	Method and Description
void	clearCodeStyleSettings()
CodeStyleSettings	clone()
void	copyFrom(CodeStyleSettings from)
boolean	equals(java.lang.Object obj)
int	getClassCountToUseImportOnDemand() Deprecated. Use JavaCodeStyleSettings.getClassCountToUseImportOnDemand()
CommonCodeStyleSettings	getCommonSettings(Language lang) Attempts to get language-specific common settings from LanguageCodeStyleSettingsProvider.
CommonCodeStyleSettings	getCommonSettings(java.lang.String langName)
int	getContinuationIndentSize(FileType fileType)
<T extends CustomCodeStyleSettings> T	getCustomSettings(java.lang.Class<T> aClass)
int	getDefaultRightMargin()
static CodeStyleSettings	getDefaults()
java.util.List<java.lang.Integer>	getDefaultSoftMargins()
ExcludedFiles	getExcludedFiles()
java.util.regex.Pattern	getFormatterOffPattern()
java.util.regex.Pattern	getFormatterOnPattern()
PackageEntryTable	getImportLayoutTable() Deprecated. Use JavaCodeStyleSettings.getImportLayoutTable()
CommonCodeStyleSettings.IndentOptions	getIndentOptions()
CommonCodeStyleSettings.IndentOptions	getIndentOptions(FileType fileType) If the file type has an associated language and language indent options are defined, returns these options.
CommonCodeStyleSettings.IndentOptions	getIndentOptionsByDocument(Project project, Document document) If the document has an associated PsiFile, returns options for this file.
CommonCodeStyleSettings.IndentOptions	getIndentOptionsByFile(PsiFile file)
CommonCodeStyleSettings.IndentOptions	getIndentOptionsByFile(PsiFile file, TextRange formatRange)
CommonCodeStyleSettings.IndentOptions	getIndentOptionsByFile(PsiFile file, TextRange formatRange, boolean ignoreDocOptions, Processor<? super FileIndentOptionsProvider> providerProcessor) Retrieves indent options for PSI file from an associated document or (if not defined in the document) from file indent options providers.
int	getIndentSize(FileType fileType)
CommonCodeStyleSettings.IndentOptions	getLanguageIndentOptions(Language language) Returns language indent options or, if the language doesn't have any options of its own, indent options configured for other file types.
java.lang.String	getLineSeparator()
SimpleModificationTracker	getModificationTracker()
int	getNamesCountToUseImportOnDemand() Deprecated. Use JavaCodeStyleSettings.getNamesCountToUseImportOnDemand()
PackageEntryTable	getPackagesToUseImportOnDemand() Deprecated. Use JavaCodeStyleSettings.getPackagesToUseImportOnDemand()
CodeStyleSettings	getParentSettings()
java.util.List<java.lang.String>	getRepeatAnnotations() Deprecated. Use JavaCodeStyleSettings.getRepeatAnnotations()
int	getRightMargin(Language language) Retrieves right margin for the given language.
java.util.List<java.lang.Integer>	getSoftMargins(Language language) Returns soft margins (visual indent guides positions) for the language.
int	getTabSize(FileType fileType)
int	getVersion()
boolean	isInsertInnerClassImports() Deprecated. Use JavaCodeStyleSettings.isInsertInnerClassImports()
boolean	isLayoutStaticImportsSeparately() Deprecated. Use JavaCodeStyleSettings.isLayoutStaticImportsSeparately()
boolean	isSmartTabs(FileType fileType)
boolean	isUseFqClassNames() Deprecated. Use JavaCodeStyleSettings.isUseFqClassNames()
boolean	isUseSingleClassImports() Deprecated. Use JavaCodeStyleSettings.isUseSingleClassImports()
boolean	isWrapOnTyping(Language language) Defines whether or not wrapping should occur when typing reaches right margin.
void	readExternal(Element element)
void	registerSettings(CodeStyleSettingsProvider provider)
void	registerSettings(LanguageCodeStyleSettingsProvider provider)
void	removeSettings(CodeStyleSettingsProvider provider)
void	removeSettings(LanguageCodeStyleSettingsProvider provider)
void	resetDeprecatedFields()
void	setClassCountToUseImportOnDemand(int value) Deprecated. Use JavaCodeStyleSettings.setClassCountToUseImportOnDemand(int)
void	setDefaultRightMargin(int rightMargin)
void	setDefaultSoftMargins(java.util.List<java.lang.Integer> softMargins) Sets the default soft margins used for languages not defining them explicitly.
void	setFormatterOffPattern(java.util.regex.Pattern formatterOffPattern)
void	setFormatterOnPattern(java.util.regex.Pattern formatterOnPattern)
void	setInsertInnerClassImports(boolean value) Deprecated. Use JavaCodeStyleSettings.setInsertInnerClassImports(boolean)
void	setLayoutStaticImportsSeparately(boolean value) Deprecated. Use JavaCodeStyleSettings.setLayoutStaticImportsSeparately(boolean)
void	setNamesCountToUseImportOnDemand(int value) Deprecated. Use JavaCodeStyleSettings.setNamesCountToUseImportOnDemand(int)
void	setParentSettings(CodeStyleSettings parent)
void	setRepeatAnnotations(java.util.List<java.lang.String> repeatAnnotations) Deprecated. Use JavaCodeStyleSettings.setRepeatAnnotations(List)
void	setRightMargin(Language language, int rightMargin) Assigns another right margin for the language or (if it is null) to root (default) margin.
void	setSoftMargins(Language language, java.util.List<java.lang.Integer> softMargins) Set soft margins (visual indent guides) for the language.
void	setUseFqClassNames(boolean value) Deprecated. Use JavaCodeStyleSettings.setUseFqClassNames(boolean)
void	setUseSingleClassImports(boolean value) Deprecated. Use JavaCodeStyleSettings.setUseSingleClassImports(boolean)
boolean	useTabCharacter(FileType fileType)
void	writeExternal(Element element)

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

arrangementSettingsEqual, clone, copyFrom, getArrangementSettings, getFileType, getLanguage, getLocalCodeStyleSettings, getRootSettings, getSoftMargins, initIndentOptions, isForceArrangeMenuAvailable, setArrangementSettings, setForceArrangeMenuAvailable

Methods inherited from class java.lang.Object

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

Field Detail

CURR_VERSION

public static final int CURR_VERSION

See Also:

Constant Field Values

VERSION_ATTR

public static final java.lang.String VERSION_ATTR

See Also:

Constant Field Values

USE_SAME_INDENTS

public boolean USE_SAME_INDENTS

IGNORE_SAME_INDENTS_FOR_LANGUAGES

public boolean IGNORE_SAME_INDENTS_FOR_LANGUAGES

AUTODETECT_INDENTS

public boolean AUTODETECT_INDENTS

OTHER_INDENT_OPTIONS

public final CommonCodeStyleSettings.IndentOptions OTHER_INDENT_OPTIONS

LINE_SEPARATOR

public java.lang.String LINE_SEPARATOR

Line separator. It can be null if choosen line separator is "System-dependent"!

FIELD_NAME_PREFIX

@Deprecated
public java.lang.String FIELD_NAME_PREFIX

Deprecated. Use JavaCodeStyleSettings.FIELD_NAME_PREFIX

STATIC_FIELD_NAME_PREFIX

@Deprecated
public java.lang.String STATIC_FIELD_NAME_PREFIX

Deprecated. Use JavaCodeStyleSettings.STATIC_FIELD_NAME_PREFIX

PARAMETER_NAME_PREFIX

@Deprecated
public java.lang.String PARAMETER_NAME_PREFIX

Deprecated. Use JavaCodeStyleSettings.PARAMETER_NAME_PREFIX

LOCAL_VARIABLE_NAME_PREFIX

@Deprecated
public java.lang.String LOCAL_VARIABLE_NAME_PREFIX

Deprecated. Use JavaCodeStyleSettings.LOCAL_VARIABLE_NAME_PREFIX

FIELD_NAME_SUFFIX

@Deprecated
public java.lang.String FIELD_NAME_SUFFIX

Deprecated. Use JavaCodeStyleSettings.FIELD_NAME_SUFFIX

STATIC_FIELD_NAME_SUFFIX

@Deprecated
public java.lang.String STATIC_FIELD_NAME_SUFFIX

Deprecated. Use JavaCodeStyleSettings.STATIC_FIELD_NAME_SUFFIX

PARAMETER_NAME_SUFFIX

@Deprecated
public java.lang.String PARAMETER_NAME_SUFFIX

Deprecated. Use JavaCodeStyleSettings.PARAMETER_NAME_SUFFIX

LOCAL_VARIABLE_NAME_SUFFIX

@Deprecated
public java.lang.String LOCAL_VARIABLE_NAME_SUFFIX

Deprecated. Use JavaCodeStyleSettings.LOCAL_VARIABLE_NAME_SUFFIX

PREFER_LONGER_NAMES

@Deprecated
public boolean PREFER_LONGER_NAMES

Deprecated. Use JavaCodeStyleSettings.PREFER_LONGER_NAMES

GENERATE_FINAL_LOCALS

@Deprecated
public boolean GENERATE_FINAL_LOCALS

Deprecated. Use JavaCodeStyleSettings.GENERATE_FINAL_LOCALS

GENERATE_FINAL_PARAMETERS

@Deprecated
public boolean GENERATE_FINAL_PARAMETERS

Deprecated. Use JavaCodeStyleSettings.GENERATE_FINAL_PARAMETERS

VISIBILITY

@Deprecated
public java.lang.String VISIBILITY

Deprecated. Use JavaCodeStyleSettings.VISIBILITY

PARENTHESES_AROUND_METHOD_ARGUMENTS

@Deprecated
public boolean PARENTHESES_AROUND_METHOD_ARGUMENTS

Deprecated. Use RubyCodeStyleSettings.PARENTHESES_AROUND_METHOD_ARGUMENTS

USE_EXTERNAL_ANNOTATIONS

@Deprecated
public boolean USE_EXTERNAL_ANNOTATIONS

Deprecated. Use JavaCodeStyleSettings.USE_EXTERNAL_ANNOTATIONS

INSERT_OVERRIDE_ANNOTATION

@Deprecated
public boolean INSERT_OVERRIDE_ANNOTATION

Deprecated. Use JavaCodeStyleSettings.INSERT_OVERRIDE_ANNOTATION

REPEAT_SYNCHRONIZED

@Deprecated
public boolean REPEAT_SYNCHRONIZED

Deprecated. Use JavaCodeStyleSettings.REPEAT_SYNCHRONIZED

LAYOUT_STATIC_IMPORTS_SEPARATELY

@Deprecated
public boolean LAYOUT_STATIC_IMPORTS_SEPARATELY

Deprecated. Use JavaCodeStyleSettings.LAYOUT_STATIC_IMPORTS_SEPARATELY

USE_FQ_CLASS_NAMES

@Deprecated
public boolean USE_FQ_CLASS_NAMES

Deprecated. Use JavaCodeStyleSettings.USE_FQ_CLASS_NAMES

USE_FQ_CLASS_NAMES_IN_JAVADOC

@Deprecated
public boolean USE_FQ_CLASS_NAMES_IN_JAVADOC

Deprecated. use JavaCodeStyleSettings.CLASS_NAMES_IN_JAVADOC instead

USE_SINGLE_CLASS_IMPORTS

@Deprecated
public boolean USE_SINGLE_CLASS_IMPORTS

Deprecated. Use {@link com.intellij.psi.codeStyle.JavaCodeStyleSettings#USE_SINGLE_CLASS_IMPORTS

INSERT_INNER_CLASS_IMPORTS

@Deprecated
public boolean INSERT_INNER_CLASS_IMPORTS

Deprecated. Use {@link com.intellij.psi.codeStyle.JavaCodeStyleSettings#INSERT_INNER_CLASS_IMPORTS

CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND

@Deprecated
public int CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND

Deprecated. Use {@link com.intellij.psi.codeStyle.JavaCodeStyleSettings#CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND

NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND

@Deprecated
public int NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND

Deprecated. Use {@link com.intellij.psi.codeStyle.JavaCodeStyleSettings#NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND

PACKAGES_TO_USE_IMPORT_ON_DEMAND

@Deprecated
public final PackageEntryTable PACKAGES_TO_USE_IMPORT_ON_DEMAND

Deprecated. Use {@link com.intellij.psi.codeStyle.JavaCodeStyleSettings#PACKAGES_TO_USE_IMPORT_ON_DEMAND

IMPORT_LAYOUT_TABLE

@Deprecated
public final PackageEntryTable IMPORT_LAYOUT_TABLE

Deprecated. Use {@link com.intellij.psi.codeStyle.JavaCodeStyleSettings#IMPORT_LAYOUT_TABLE

STATIC_FIELDS_ORDER_WEIGHT

@Deprecated
public int STATIC_FIELDS_ORDER_WEIGHT

Deprecated.

FIELDS_ORDER_WEIGHT

@Deprecated
public int FIELDS_ORDER_WEIGHT

Deprecated.

CONSTRUCTORS_ORDER_WEIGHT

@Deprecated
public int CONSTRUCTORS_ORDER_WEIGHT

Deprecated.

STATIC_METHODS_ORDER_WEIGHT

@Deprecated
public int STATIC_METHODS_ORDER_WEIGHT

Deprecated.

METHODS_ORDER_WEIGHT

@Deprecated
public int METHODS_ORDER_WEIGHT

Deprecated.

STATIC_INNER_CLASSES_ORDER_WEIGHT

@Deprecated
public int STATIC_INNER_CLASSES_ORDER_WEIGHT

Deprecated.

INNER_CLASSES_ORDER_WEIGHT

@Deprecated
public int INNER_CLASSES_ORDER_WEIGHT

Deprecated.

RIGHT_MARGIN

public int RIGHT_MARGIN

WRAP_WHEN_TYPING_REACHES_RIGHT_MARGIN

public boolean WRAP_WHEN_TYPING_REACHES_RIGHT_MARGIN

Do not use this field directly since it doesn't reflect a setting for a specific language which may overwrite this one. Call isWrapOnTyping(Language) method instead.

See Also:

CommonCodeStyleSettings.WRAP_ON_TYPING

ENABLE_JAVADOC_FORMATTING

@Deprecated
public boolean ENABLE_JAVADOC_FORMATTING

Deprecated. Use JavaCodeStyleSettings.ENABLE_JAVADOC_FORMATTING

JD_LEADING_ASTERISKS_ARE_ENABLED

@Deprecated
public boolean JD_LEADING_ASTERISKS_ARE_ENABLED

Deprecated. Use JavaCodeStyleSettings.JD_LEADING_ASTERISKS_ARE_ENABLED

HTML_KEEP_WHITESPACES

@Deprecated
public boolean HTML_KEEP_WHITESPACES

Deprecated. Use HtmlCodeStyleSettings

HTML_ATTRIBUTE_WRAP

@Deprecated
public int HTML_ATTRIBUTE_WRAP

Deprecated. Use HtmlCodeStyleSettings

HTML_TEXT_WRAP

@Deprecated
public int HTML_TEXT_WRAP

Deprecated. Use HtmlCodeStyleSettings

HTML_KEEP_LINE_BREAKS

@Deprecated
public boolean HTML_KEEP_LINE_BREAKS

Deprecated. Use HtmlCodeStyleSettings

HTML_KEEP_LINE_BREAKS_IN_TEXT

@Deprecated
public boolean HTML_KEEP_LINE_BREAKS_IN_TEXT

Deprecated. Use HtmlCodeStyleSettings

HTML_KEEP_BLANK_LINES

@Deprecated
public int HTML_KEEP_BLANK_LINES

Deprecated. Use HtmlCodeStyleSettings

HTML_ALIGN_ATTRIBUTES

@Deprecated
public boolean HTML_ALIGN_ATTRIBUTES

Deprecated. Use HtmlCodeStyleSettings

HTML_ALIGN_TEXT

@Deprecated
public boolean HTML_ALIGN_TEXT

Deprecated. Use HtmlCodeStyleSettings

HTML_SPACE_AROUND_EQUALITY_IN_ATTRINUTE

@Deprecated
public boolean HTML_SPACE_AROUND_EQUALITY_IN_ATTRINUTE

Deprecated. Use HtmlCodeStyleSettings

HTML_SPACE_AFTER_TAG_NAME

@Deprecated
public boolean HTML_SPACE_AFTER_TAG_NAME

Deprecated. Use HtmlCodeStyleSettings

HTML_SPACE_INSIDE_EMPTY_TAG

@Deprecated
public boolean HTML_SPACE_INSIDE_EMPTY_TAG

Deprecated. Use HtmlCodeStyleSettings

HTML_ELEMENTS_TO_INSERT_NEW_LINE_BEFORE

@Deprecated
public java.lang.String HTML_ELEMENTS_TO_INSERT_NEW_LINE_BEFORE

Deprecated. Use HtmlCodeStyleSettings

HTML_ELEMENTS_TO_REMOVE_NEW_LINE_BEFORE

@Deprecated
public java.lang.String HTML_ELEMENTS_TO_REMOVE_NEW_LINE_BEFORE

Deprecated. Use HtmlCodeStyleSettings

HTML_DO_NOT_INDENT_CHILDREN_OF

@Deprecated
public java.lang.String HTML_DO_NOT_INDENT_CHILDREN_OF

Deprecated. Use HtmlCodeStyleSettings

HTML_DO_NOT_ALIGN_CHILDREN_OF_MIN_LINES

@Deprecated
public int HTML_DO_NOT_ALIGN_CHILDREN_OF_MIN_LINES

Deprecated. Use HtmlCodeStyleSettings

HTML_KEEP_WHITESPACES_INSIDE

@Deprecated
public java.lang.String HTML_KEEP_WHITESPACES_INSIDE

Deprecated. Use HtmlCodeStyleSettings

HTML_INLINE_ELEMENTS

@Deprecated
public java.lang.String HTML_INLINE_ELEMENTS

Deprecated. Use HtmlCodeStyleSettings

HTML_DONT_ADD_BREAKS_IF_INLINE_CONTENT

@Deprecated
public java.lang.String HTML_DONT_ADD_BREAKS_IF_INLINE_CONTENT

Deprecated. Use HtmlCodeStyleSettings

HTML_QUOTE_STYLE

@Deprecated
public CodeStyleSettings.QuoteStyle HTML_QUOTE_STYLE

Deprecated. Use HtmlCodeStyleSettings

HTML_ENFORCE_QUOTES

@Deprecated
public boolean HTML_ENFORCE_QUOTES

Deprecated. Use HtmlCodeStyleSettings

HTML_NEWLINE_BEFORE_FIRST_ATTRIBUTE

@Deprecated
public CodeStyleSettings.HtmlTagNewLineStyle HTML_NEWLINE_BEFORE_FIRST_ATTRIBUTE

Deprecated. Use HtmlCodeStyleSettings

HTML_NEWLINE_AFTER_LAST_ATTRIBUTE

@Deprecated
public CodeStyleSettings.HtmlTagNewLineStyle HTML_NEWLINE_AFTER_LAST_ATTRIBUTE

Deprecated. Use HtmlCodeStyleSettings

JSP_PREFER_COMMA_SEPARATED_IMPORT_LIST

@Deprecated
public boolean JSP_PREFER_COMMA_SEPARATED_IMPORT_LIST

Deprecated. Use com.intellij.application.options.JspCodeStyleSettings#JSP_PREFER_COMMA_SEPARATED_IMPORT_LIST

FORMATTER_TAGS_ENABLED

public boolean FORMATTER_TAGS_ENABLED

FORMATTER_ON_TAG

public java.lang.String FORMATTER_ON_TAG

FORMATTER_OFF_TAG

public java.lang.String FORMATTER_OFF_TAG

FORMATTER_TAGS_ACCEPT_REGEXP

public volatile boolean FORMATTER_TAGS_ACCEPT_REGEXP

Constructor Detail

CodeStyleSettings

public CodeStyleSettings()

CodeStyleSettings

public CodeStyleSettings(boolean loadExtensions)

Method Detail

setParentSettings

public void setParentSettings(CodeStyleSettings parent)

getParentSettings

public CodeStyleSettings getParentSettings()

getCustomSettings

public <T extends CustomCodeStyleSettings> T getCustomSettings(java.lang.Class<T> aClass)

clone

public CodeStyleSettings clone()

Overrides:

clone in class java.lang.Object

copyFrom

public void copyFrom(CodeStyleSettings from)

getLineSeparator

public java.lang.String getLineSeparator()

Returns:

line separator. If the chosen line separator is "System-dependent", return default separator for this OS.

getRepeatAnnotations

@Deprecated
public java.util.List<java.lang.String> getRepeatAnnotations()

Deprecated. Use JavaCodeStyleSettings.getRepeatAnnotations()

setRepeatAnnotations

@Deprecated
public void setRepeatAnnotations(java.util.List<java.lang.String> repeatAnnotations)

Deprecated. Use JavaCodeStyleSettings.setRepeatAnnotations(List)

isLayoutStaticImportsSeparately

@Deprecated
public boolean isLayoutStaticImportsSeparately()

Deprecated. Use JavaCodeStyleSettings.isLayoutStaticImportsSeparately()

Specified by:

isLayoutStaticImportsSeparately in interface ImportsLayoutSettings

setLayoutStaticImportsSeparately

@Deprecated
public void setLayoutStaticImportsSeparately(boolean value)

Deprecated. Use JavaCodeStyleSettings.setLayoutStaticImportsSeparately(boolean)

Specified by:

setLayoutStaticImportsSeparately in interface ImportsLayoutSettings

getNamesCountToUseImportOnDemand

@Deprecated
public int getNamesCountToUseImportOnDemand()

Deprecated. Use JavaCodeStyleSettings.getNamesCountToUseImportOnDemand()

Specified by:

getNamesCountToUseImportOnDemand in interface ImportsLayoutSettings

setNamesCountToUseImportOnDemand

@Deprecated
public void setNamesCountToUseImportOnDemand(int value)

Deprecated. Use JavaCodeStyleSettings.setNamesCountToUseImportOnDemand(int)

Specified by:

setNamesCountToUseImportOnDemand in interface ImportsLayoutSettings

getClassCountToUseImportOnDemand

@Deprecated
public int getClassCountToUseImportOnDemand()

Deprecated. Use JavaCodeStyleSettings.getClassCountToUseImportOnDemand()

Specified by:

getClassCountToUseImportOnDemand in interface ImportsLayoutSettings

setClassCountToUseImportOnDemand

@Deprecated
public void setClassCountToUseImportOnDemand(int value)

Deprecated. Use JavaCodeStyleSettings.setClassCountToUseImportOnDemand(int)

Specified by:

setClassCountToUseImportOnDemand in interface ImportsLayoutSettings

isInsertInnerClassImports

@Deprecated
public boolean isInsertInnerClassImports()

Deprecated. Use JavaCodeStyleSettings.isInsertInnerClassImports()

Specified by:

isInsertInnerClassImports in interface ImportsLayoutSettings

setInsertInnerClassImports

@Deprecated
public void setInsertInnerClassImports(boolean value)

Deprecated. Use JavaCodeStyleSettings.setInsertInnerClassImports(boolean)

Specified by:

setInsertInnerClassImports in interface ImportsLayoutSettings

isUseSingleClassImports

@Deprecated
public boolean isUseSingleClassImports()

Deprecated. Use JavaCodeStyleSettings.isUseSingleClassImports()

Specified by:

isUseSingleClassImports in interface ImportsLayoutSettings

setUseSingleClassImports

@Deprecated
public void setUseSingleClassImports(boolean value)

Deprecated. Use JavaCodeStyleSettings.setUseSingleClassImports(boolean)

Specified by:

setUseSingleClassImports in interface ImportsLayoutSettings

isUseFqClassNames

@Deprecated
public boolean isUseFqClassNames()

Deprecated. Use JavaCodeStyleSettings.isUseFqClassNames()

Specified by:

isUseFqClassNames in interface ImportsLayoutSettings

setUseFqClassNames

@Deprecated
public void setUseFqClassNames(boolean value)

Deprecated. Use JavaCodeStyleSettings.setUseFqClassNames(boolean)

Specified by:

setUseFqClassNames in interface ImportsLayoutSettings

getImportLayoutTable

@Deprecated
public PackageEntryTable getImportLayoutTable()

Deprecated. Use JavaCodeStyleSettings.getImportLayoutTable()

Specified by:

getImportLayoutTable in interface ImportsLayoutSettings

getPackagesToUseImportOnDemand

@Deprecated
public PackageEntryTable getPackagesToUseImportOnDemand()

Deprecated. Use JavaCodeStyleSettings.getPackagesToUseImportOnDemand()

Specified by:

getPackagesToUseImportOnDemand in interface ImportsLayoutSettings

getFormatterOffPattern

public java.util.regex.Pattern getFormatterOffPattern()

setFormatterOffPattern

public void setFormatterOffPattern(java.util.regex.Pattern formatterOffPattern)

getFormatterOnPattern

public java.util.regex.Pattern getFormatterOnPattern()

setFormatterOnPattern

public void setFormatterOnPattern(java.util.regex.Pattern formatterOnPattern)

readExternal

public void readExternal(Element element)
                  throws InvalidDataException

Specified by:

readExternal in interface JDOMExternalizable

Overrides:

readExternal in class CommonCodeStyleSettings

Throws:

InvalidDataException

writeExternal

public void writeExternal(Element element)
                   throws WriteExternalException

Specified by:

writeExternal in interface JDOMExternalizable

Overrides:

writeExternal in class CommonCodeStyleSettings

Throws:

WriteExternalException

getIndentOptions

public CommonCodeStyleSettings.IndentOptions getIndentOptions()

Overrides:

getIndentOptions in class CommonCodeStyleSettings

getIndentOptions

public CommonCodeStyleSettings.IndentOptions getIndentOptions(FileType fileType)

If the file type has an associated language and language indent options are defined, returns these options. Otherwise attempts to find indent options from FileTypeIndentOptionsProvider. If none are found, other indent options are returned.

Parameters:

fileType - The file type to search indent options for.

Returns:

File type indent options or OTHER_INDENT_OPTIONS.

See Also:

FileTypeIndentOptionsProvider, LanguageCodeStyleSettingsProvider

getIndentOptionsByDocument

public CommonCodeStyleSettings.IndentOptions getIndentOptionsByDocument(Project project,
                                                                        Document document)

If the document has an associated PsiFile, returns options for this file. Otherwise attempts to find associated VirtualFile and return options for corresponding FileType. If none are found, other indent options are returned.

Parameters:

project - The project in which PsiFile should be searched.

document - The document to search indent options for.

Returns:

Indent options from the indent options providers or file type indent options or OTHER_INDENT_OPTIONS.

See Also:

FileIndentOptionsProvider, FileTypeIndentOptionsProvider, LanguageCodeStyleSettingsProvider

getIndentOptionsByFile

public CommonCodeStyleSettings.IndentOptions getIndentOptionsByFile(PsiFile file)

getIndentOptionsByFile

public CommonCodeStyleSettings.IndentOptions getIndentOptionsByFile(PsiFile file,
                                                                    TextRange formatRange)

getIndentOptionsByFile

public CommonCodeStyleSettings.IndentOptions getIndentOptionsByFile(PsiFile file,
                                                                    TextRange formatRange,
                                                                    boolean ignoreDocOptions,
                                                                    Processor<? super FileIndentOptionsProvider> providerProcessor)

Retrieves indent options for PSI file from an associated document or (if not defined in the document) from file indent options providers.

Parameters:

file - The PSI file to retrieve options for.

formatRange - The text range within the file for formatting purposes or null if there is either no specific range or multiple ranges. If the range covers the entire file (full reformat), options stored in the document are ignored and indent options are taken from file indent options providers.

ignoreDocOptions - Ignore options stored in the document and use file indent options providers even if there is no text range or the text range doesn't cover the entire file.

providerProcessor - A callback object containing a reference to indent option provider which has returned indent options.

Returns:

Indent options from the associated document or file indent options providers.

See Also:

FileIndentOptionsProvider

getLanguageIndentOptions

public CommonCodeStyleSettings.IndentOptions getLanguageIndentOptions(Language language)

Returns language indent options or, if the language doesn't have any options of its own, indent options configured for other file types.

Parameters:

language - The language to get indent options for.

Returns:

Language indent options.

isSmartTabs

public boolean isSmartTabs(FileType fileType)

getIndentSize

public int getIndentSize(FileType fileType)

getContinuationIndentSize

public int getContinuationIndentSize(FileType fileType)

getTabSize

public int getTabSize(FileType fileType)

useTabCharacter

public boolean useTabCharacter(FileType fileType)

clearCodeStyleSettings

public void clearCodeStyleSettings()

getCommonSettings

public CommonCodeStyleSettings getCommonSettings(Language lang)

Attempts to get language-specific common settings from LanguageCodeStyleSettingsProvider.

Parameters:

lang - The language to get settings for.

Returns:

If the provider for the language exists and is able to create language-specific default settings (LanguageCodeStyleSettingsProvider.getDefaultCommonSettings() doesn't return null) returns the instance of settings for this language. Otherwise returns new instance of common code style settings with default values.

getCommonSettings

public CommonCodeStyleSettings getCommonSettings(java.lang.String langName)

Parameters:

langName - The language name.

Returns:

Language-specific code style settings or shared settings if not found.

See Also:

CommonCodeStyleSettingsManager.getCommonSettings(com.intellij.lang.Language)

getRightMargin

public int getRightMargin(Language language)

Retrieves right margin for the given language. The language may overwrite default RIGHT_MARGIN value with its own RIGHT_MARGIN in language's CommonCodeStyleSettings instance.

Parameters:

language - The language to get right margin for or null if root (default) right margin is requested.

Returns:

The right margin for the language if it is defined (not null) and its settings contain non-negative margin. Root (default) margin otherwise (CodeStyleSettings.RIGHT_MARGIN).

setRightMargin

public void setRightMargin(Language language,
                           int rightMargin)

Assigns another right margin for the language or (if it is null) to root (default) margin.

Parameters:

language - The language to assign the right margin to or null if root (default) right margin is to be changed.

rightMargin - New right margin.

getDefaultRightMargin

public int getDefaultRightMargin()

setDefaultRightMargin

public void setDefaultRightMargin(int rightMargin)

isWrapOnTyping

public boolean isWrapOnTyping(Language language)

Defines whether or not wrapping should occur when typing reaches right margin.

Parameters:

language - The language to check the option for or null for a global option.

Returns:

True if wrapping on right margin is enabled.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class CommonCodeStyleSettings

getDefaults

public static CodeStyleSettings getDefaults()

resetDeprecatedFields

public void resetDeprecatedFields()

getVersion

public int getVersion()

getSoftMargins

public java.util.List<java.lang.Integer> getSoftMargins(Language language)

Returns soft margins (visual indent guides positions) for the language. If language settings do not exists or language soft margins are empty, default (root) soft margins are returned.

Parameters:

language - The language to retrieve soft margins for or null for default soft margins.

Returns:

Language or default soft margins.

See Also:

getDefaultSoftMargins()

setSoftMargins

public void setSoftMargins(Language language,
                           java.util.List<java.lang.Integer> softMargins)

Set soft margins (visual indent guides) for the language. Note: language code style settings must exist.

Parameters:

language - The language to set soft margins for.

softMargins - The soft margins to set.

getDefaultSoftMargins

public java.util.List<java.lang.Integer> getDefaultSoftMargins()

Returns:

Default (root) soft margins used for languages not defining them explicitly.

setDefaultSoftMargins

public void setDefaultSoftMargins(java.util.List<java.lang.Integer> softMargins)

Sets the default soft margins used for languages not defining them explicitly.

Parameters:

softMargins - The default soft margins.

getExcludedFiles

public ExcludedFiles getExcludedFiles()

getModificationTracker

public SimpleModificationTracker getModificationTracker()

removeSettings

public void removeSettings(LanguageCodeStyleSettingsProvider provider)

registerSettings

public void registerSettings(LanguageCodeStyleSettingsProvider provider)

removeSettings

public void removeSettings(CodeStyleSettingsProvider provider)

registerSettings

public void registerSettings(CodeStyleSettingsProvider provider)