CommonCodeStyleSettings.IndentOptions (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.psi.codeStyle.CommonCodeStyleSettings.IndentOptions

All Implemented Interfaces:

JDOMExternalizable, java.lang.Cloneable

Direct Known Subclasses:

TimeStampedIndentOptions

Enclosing class:

CommonCodeStyleSettings
```
public static class CommonCodeStyleSettings.IndentOptions
extends java.lang.Object
implements java.lang.Cloneable, JDOMExternalizable
```

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`ARRAY_ELEMENT_INDENT`
`int`	`CALL_PARAMETER_INDENT`
`int`	`CHAINED_CALL_INDENT`
`int`	`CONTINUATION_INDENT_SIZE`
`int`	`DECLARATION_PARAMETER_INDENT`
`static CommonCodeStyleSettings.IndentOptions`	`DEFAULT_INDENT_OPTIONS`
`int`	`GENERIC_TYPE_PARAMETER_INDENT`
`int`	`INDENT_SIZE`
`boolean`	`KEEP_INDENTS_ON_EMPTY_LINES`
`boolean`	`LABEL_INDENT_ABSOLUTE`
`int`	`LABEL_INDENT_SIZE`
`boolean`	`SMART_TABS`
`int`	`TAB_SIZE`
`boolean`	`USE_RELATIVE_INDENTS`
`boolean`	`USE_TAB_CHARACTER`

Constructor Summary

Constructors
Constructor and Description

IndentOptions()

Constructors
Constructor and Description
`IndentOptions()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`associateWithDocument(Document document)`
`java.lang.Object`	`clone()`
`void`	`copyFrom(CommonCodeStyleSettings.IndentOptions other)`
`void`	`deserialize(Element indentOptionsElement)`
`boolean`	`equals(java.lang.Object o)`
`FileIndentOptionsProvider`	`getFileIndentOptionsProvider()`
`int`	`hashCode()`
`boolean`	`isOverrideLanguageOptions()`
`void`	`readExternal(Element element)`
`static CommonCodeStyleSettings.IndentOptions`	`retrieveFromAssociatedDocument(PsiFile file)`
`void`	`serialize(Element indentOptionsElement, CommonCodeStyleSettings.IndentOptions defaultOptions)`
`void`	`setOverrideLanguageOptions(boolean overrideLanguageOptions)` Make the indent options override options defined for a language block if the block implements `BlockEx.getLanguage()` Useful when indent options provider must take a priority over any language settings for a formatter block.
`void`	`writeExternal(Element element)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_INDENT_OPTIONS

public static final CommonCodeStyleSettings.IndentOptions DEFAULT_INDENT_OPTIONS

INDENT_SIZE
```
public int INDENT_SIZE
```

CONTINUATION_INDENT_SIZE
```
public int CONTINUATION_INDENT_SIZE
```

TAB_SIZE
```
public int TAB_SIZE
```

USE_TAB_CHARACTER
```
public boolean USE_TAB_CHARACTER
```

SMART_TABS
```
public boolean SMART_TABS
```

LABEL_INDENT_SIZE
```
public int LABEL_INDENT_SIZE
```

LABEL_INDENT_ABSOLUTE
```
public boolean LABEL_INDENT_ABSOLUTE
```

USE_RELATIVE_INDENTS
```
public boolean USE_RELATIVE_INDENTS
```

KEEP_INDENTS_ON_EMPTY_LINES

public boolean KEEP_INDENTS_ON_EMPTY_LINES

DECLARATION_PARAMETER_INDENT

public int DECLARATION_PARAMETER_INDENT

GENERIC_TYPE_PARAMETER_INDENT

public int GENERIC_TYPE_PARAMETER_INDENT

CALL_PARAMETER_INDENT
```
public int CALL_PARAMETER_INDENT
```

CHAINED_CALL_INDENT
```
public int CHAINED_CALL_INDENT
```

ARRAY_ELEMENT_INDENT
```
public int ARRAY_ELEMENT_INDENT
```

Constructor Detail
- IndentOptions
```
public IndentOptions()
```

Method Detail
- readExternal
```
public void readExternal(Element element)
```
  Specified by:
  
  readExternal in interface JDOMExternalizable
- writeExternal
```
public void writeExternal(Element element)
```
  Specified by:
  
  writeExternal in interface JDOMExternalizable
- serialize
```
public void serialize(Element indentOptionsElement,
                      CommonCodeStyleSettings.IndentOptions defaultOptions)
```
- deserialize
```
public void deserialize(Element indentOptionsElement)
```
- clone
```
public java.lang.Object clone()
```
  Overrides:
  
  clone in class java.lang.Object
- equals
```
public boolean equals(java.lang.Object o)
```
  Overrides:
  
  equals in class java.lang.Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class java.lang.Object
- copyFrom
```
public void copyFrom(CommonCodeStyleSettings.IndentOptions other)
```
- getFileIndentOptionsProvider
```
public FileIndentOptionsProvider getFileIndentOptionsProvider()
```
- associateWithDocument
```
public void associateWithDocument(Document document)
```
- retrieveFromAssociatedDocument
```
public static CommonCodeStyleSettings.IndentOptions retrieveFromAssociatedDocument(PsiFile file)
```
- isOverrideLanguageOptions
```
public boolean isOverrideLanguageOptions()
```
  Returns:
  
  True if the options can override the ones defined in language settings.
  
  See Also:
  
  setOverrideLanguageOptions(boolean)
- setOverrideLanguageOptions
```
public void setOverrideLanguageOptions(boolean overrideLanguageOptions)
```
  Make the indent options override options defined for a language block if the block implements BlockEx.getLanguage() Useful when indent options provider must take a priority over any language settings for a formatter block.
  
  Parameters:
  
  overrideLanguageOptions - True if language block options should be ignored.
  
  See Also:
  
  FileIndentOptionsProvider

Class CommonCodeStyleSettings.IndentOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_INDENT_OPTIONS

INDENT_SIZE

CONTINUATION_INDENT_SIZE

TAB_SIZE

USE_TAB_CHARACTER

SMART_TABS

LABEL_INDENT_SIZE

LABEL_INDENT_ABSOLUTE

USE_RELATIVE_INDENTS

KEEP_INDENTS_ON_EMPTY_LINES

DECLARATION_PARAMETER_INDENT

GENERIC_TYPE_PARAMETER_INDENT

CALL_PARAMETER_INDENT

CHAINED_CALL_INDENT

ARRAY_ELEMENT_INDENT

Constructor Detail

IndentOptions

Method Detail

readExternal

writeExternal

serialize

deserialize

clone

equals

hashCode

copyFrom

getFileIndentOptionsProvider

associateWithDocument

retrieveFromAssociatedDocument

isOverrideLanguageOptions

setOverrideLanguageOptions