EditorSettings (Unofficial IntelliJ Community Edition API docs)

All Known Implementing Classes:

SettingsImpl
```
public interface EditorSettings
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`areGutterIconsShown()`
`int`	`getAdditionalColumnsCount()`
`int`	`getAdditionalLinesCount()`
`int`	`getCaretBlinkPeriod()`
`int`	`getCustomSoftWrapIndent()`
`int`	`getLineCursorWidth()`
`int`	`getRightMargin(Project project)`
`java.util.List<java.lang.Integer>`	`getSoftMargins()` Retrieves a list of soft margins (visual indent guides) to be used in the editor.
`int`	`getTabSize(Project project)`
`boolean`	`isAdditionalPageAtBottom()`
`boolean`	`isAllowSingleLogicalLineFolding()`
`boolean`	`isAllSoftWrapsShown()`
`boolean`	`isAnimatedScrolling()`
`boolean`	`isAutoCodeFoldingEnabled()`
`boolean`	`isBlinkCaret()`
`boolean`	`isBlockCursor()`
`boolean`	`isCamelWords()`
`boolean`	`isCaretInsideTabs()`
`boolean`	`isCaretRowShown()`
`boolean`	`isDndEnabled()`
`boolean`	`isFoldingOutlineShown()`
`boolean`	`isIndentGuidesShown()`
`boolean`	`isInnerWhitespaceShown()`
`boolean`	`isLeadingWhitespaceShown()`
`boolean`	`isLineMarkerAreaShown()`
`boolean`	`isLineNumbersShown()`
`boolean`	`isMouseClickSelectionHonorsCamelWords()`
`boolean`	`isPreselectRename()`
`boolean`	`isRefrainFromScrolling()`
`boolean`	`isRightMarginShown()`
`boolean`	`isShowIntentionBulb()`
`boolean`	`isSmartHome()`
`boolean`	`isTrailingWhitespaceShown()`
`boolean`	`isUseCustomSoftWrapIndent()`
`boolean`	`isUseSoftWraps()`
`boolean`	`isUseTabCharacter(Project project)`
`boolean`	`isVariableInplaceRenameEnabled()`
`boolean`	`isVirtualSpace()`
`boolean`	`isWheelFontChangeEnabled()`
`boolean`	`isWhitespacesShown()`
`boolean`	`isWrapWhenTypingReachesRightMargin(Project project)`
`void`	`resetCamelWords()` Allows to remove 'use camel words' setup specific to the current settings object (if any) and use the shared one.
`void`	`setAdditionalColumnsCount(int additionalColumnsCount)`
`void`	`setAdditionalLinesCount(int additionalLinesCount)`
`void`	`setAdditionalPageAtBottom(boolean val)`
`void`	`setAllowSingleLogicalLineFolding(boolean allow)` By default, gutter mark (for collapsing/expanding the region using mouse) is not shown for a folding region, if it's contained within a single document line.
`void`	`setAnimatedScrolling(boolean val)`
`void`	`setAutoCodeFoldingEnabled(boolean val)`
`void`	`setBlinkCaret(boolean blinkCaret)`
`void`	`setBlockCursor(boolean blockCursor)`
`void`	`setCamelWords(boolean val)`
`void`	`setCaretBlinkPeriod(int blinkPeriod)`
`void`	`setCaretInsideTabs(boolean allow)`
`void`	`setCaretRowShown(boolean caretRowShown)`
`void`	`setCustomSoftWrapIndent(int indent)`
`void`	`setDndEnabled(boolean val)`
`void`	`setFoldingOutlineShown(boolean val)`
`void`	`setGutterIconsShown(boolean gutterIconsShown)`
`void`	`setIndentGuidesShown(boolean val)`
`void`	`setInnerWhitespaceShown(boolean val)`
`default void`	`setLanguage(Language language)` Deprecated.
`void`	`setLanguageSupplier(java.util.function.Supplier<? extends Language> languageSupplier)`
`void`	`setLeadingWhitespaceShown(boolean val)`
`void`	`setLineCursorWidth(int width)`
`void`	`setLineMarkerAreaShown(boolean lineMarkerAreaShown)`
`void`	`setLineNumbersShown(boolean val)`
`void`	`setMouseClickSelectionHonorsCamelWords(boolean val)`
`void`	`setPreselectRename(boolean val)`
`void`	`setRefrainFromScrolling(boolean b)`
`void`	`setRightMargin(int myRightMargin)`
`void`	`setRightMarginShown(boolean val)`
`void`	`setShowIntentionBulb(boolean show)`
`void`	`setSmartHome(boolean val)`
`void`	`setSoftMargins(java.util.List<java.lang.Integer> softMargins)` Explicitly sets soft margins (visual indent guides) to be used in the editor instead of obtaining them from code style settings via `CodeStyleSettings.getSoftMargins()` method.
`void`	`setTabSize(int tabSize)`
`void`	`setTrailingWhitespaceShown(boolean val)`
`void`	`setUseCustomSoftWrapIndent(boolean useCustomSoftWrapIndent)`
`void`	`setUseSoftWraps(boolean use)`
`void`	`setUseTabCharacter(boolean useTabCharacter)`
`void`	`setVariableInplaceRenameEnabled(boolean val)`
`void`	`setVirtualSpace(boolean allow)`
`void`	`setWheelFontChangeEnabled(boolean val)`
`void`	`setWhitespacesShown(boolean val)`
`void`	`setWrapWhenTypingReachesRightMargin(boolean val)`

- Method Detail
  - isRightMarginShown
```
boolean isRightMarginShown()
```
  - setRightMarginShown
```
void setRightMarginShown(boolean val)
```
  - isWhitespacesShown
```
boolean isWhitespacesShown()
```
  - setWhitespacesShown
```
void setWhitespacesShown(boolean val)
```
  - isLeadingWhitespaceShown
```
boolean isLeadingWhitespaceShown()
```
  - setLeadingWhitespaceShown
```
void setLeadingWhitespaceShown(boolean val)
```
  - isInnerWhitespaceShown
```
boolean isInnerWhitespaceShown()
```
  - setInnerWhitespaceShown
```
void setInnerWhitespaceShown(boolean val)
```
  - isTrailingWhitespaceShown
```
boolean isTrailingWhitespaceShown()
```
  - setTrailingWhitespaceShown
```
void setTrailingWhitespaceShown(boolean val)
```
  - getRightMargin
```
int getRightMargin(Project project)
```
  - setRightMargin
```
void setRightMargin(int myRightMargin)
```
  - getSoftMargins
```
java.util.List<java.lang.Integer> getSoftMargins()
```
    Retrieves a list of soft margins (visual indent guides) to be used in the editor. If soft margins haven't been explicitly set with setSoftMargins(List) method, they are obtained from code style settings: CodeStyleSettings.getSoftMargins().
    
    Returns:
    
    A list of current editor soft margins. The list may be empty if no soft margins are defined.
  - setSoftMargins
```
void setSoftMargins(java.util.List<java.lang.Integer> softMargins)
```
    Explicitly sets soft margins (visual indent guides) to be used in the editor instead of obtaining them from code style settings via CodeStyleSettings.getSoftMargins() method. It is important to distinguish and empty list from null value: the first will define no soft margins for the eidtor while the latter will restore the default behavior of using them from code style settings.
    
    Parameters:
    
    softMargins - A list of soft margins or null to use margins from code style settings.
  - isWrapWhenTypingReachesRightMargin
```
boolean isWrapWhenTypingReachesRightMargin(Project project)
```
  - setWrapWhenTypingReachesRightMargin
```
void setWrapWhenTypingReachesRightMargin(boolean val)
```
  - isLineNumbersShown
```
boolean isLineNumbersShown()
```
  - setLineNumbersShown
```
void setLineNumbersShown(boolean val)
```
  - getAdditionalLinesCount
```
int getAdditionalLinesCount()
```
  - setAdditionalLinesCount
```
void setAdditionalLinesCount(int additionalLinesCount)
```
  - getAdditionalColumnsCount
```
int getAdditionalColumnsCount()
```
  - setAdditionalColumnsCount
```
void setAdditionalColumnsCount(int additionalColumnsCount)
```
  - isLineMarkerAreaShown
```
boolean isLineMarkerAreaShown()
```
  - setLineMarkerAreaShown
```
void setLineMarkerAreaShown(boolean lineMarkerAreaShown)
```
  - areGutterIconsShown
```
boolean areGutterIconsShown()
```
  - setGutterIconsShown
```
void setGutterIconsShown(boolean gutterIconsShown)
```
  - isFoldingOutlineShown
```
boolean isFoldingOutlineShown()
```
  - setFoldingOutlineShown
```
void setFoldingOutlineShown(boolean val)
```
  - isAutoCodeFoldingEnabled
```
boolean isAutoCodeFoldingEnabled()
```
  - setAutoCodeFoldingEnabled
```
void setAutoCodeFoldingEnabled(boolean val)
```
  - isUseTabCharacter
```
boolean isUseTabCharacter(Project project)
```
  - setUseTabCharacter
```
void setUseTabCharacter(boolean useTabCharacter)
```
  - getTabSize
```
int getTabSize(Project project)
```
  - setTabSize
```
void setTabSize(int tabSize)
```
  - isSmartHome
```
boolean isSmartHome()
```
  - setSmartHome
```
void setSmartHome(boolean val)
```
  - isVirtualSpace
```
boolean isVirtualSpace()
```
  - setVirtualSpace
```
void setVirtualSpace(boolean allow)
```
  - isCaretInsideTabs
```
boolean isCaretInsideTabs()
```
  - setCaretInsideTabs
```
void setCaretInsideTabs(boolean allow)
```
  - isBlinkCaret
```
boolean isBlinkCaret()
```
  - setBlinkCaret
```
void setBlinkCaret(boolean blinkCaret)
```
  - getCaretBlinkPeriod
```
int getCaretBlinkPeriod()
```
  - setCaretBlinkPeriod
```
void setCaretBlinkPeriod(int blinkPeriod)
```
  - isBlockCursor
```
boolean isBlockCursor()
```
  - setBlockCursor
```
void setBlockCursor(boolean blockCursor)
```
  - isCaretRowShown
```
boolean isCaretRowShown()
```
  - setCaretRowShown
```
void setCaretRowShown(boolean caretRowShown)
```
  - getLineCursorWidth
```
int getLineCursorWidth()
```
  - setLineCursorWidth
```
void setLineCursorWidth(int width)
```
  - isAnimatedScrolling
```
boolean isAnimatedScrolling()
```
  - setAnimatedScrolling
```
void setAnimatedScrolling(boolean val)
```
  - isCamelWords
```
boolean isCamelWords()
```
  - setCamelWords
```
void setCamelWords(boolean val)
```
  - resetCamelWords
```
void resetCamelWords()
```
    Allows to remove 'use camel words' setup specific to the current settings object (if any) and use the shared one.
  - isAdditionalPageAtBottom
```
boolean isAdditionalPageAtBottom()
```
  - setAdditionalPageAtBottom
```
void setAdditionalPageAtBottom(boolean val)
```
  - isDndEnabled
```
boolean isDndEnabled()
```
  - setDndEnabled
```
void setDndEnabled(boolean val)
```
  - isWheelFontChangeEnabled
```
boolean isWheelFontChangeEnabled()
```
  - setWheelFontChangeEnabled
```
void setWheelFontChangeEnabled(boolean val)
```
  - isMouseClickSelectionHonorsCamelWords
```
boolean isMouseClickSelectionHonorsCamelWords()
```
  - setMouseClickSelectionHonorsCamelWords
```
void setMouseClickSelectionHonorsCamelWords(boolean val)
```
  - isVariableInplaceRenameEnabled
```
boolean isVariableInplaceRenameEnabled()
```
  - setVariableInplaceRenameEnabled
```
void setVariableInplaceRenameEnabled(boolean val)
```
  - isRefrainFromScrolling
```
boolean isRefrainFromScrolling()
```
  - setRefrainFromScrolling
```
void setRefrainFromScrolling(boolean b)
```
  - isIndentGuidesShown
```
boolean isIndentGuidesShown()
```
  - setIndentGuidesShown
```
void setIndentGuidesShown(boolean val)
```
  - isUseSoftWraps
```
boolean isUseSoftWraps()
```
  - setUseSoftWraps
```
void setUseSoftWraps(boolean use)
```
  - isAllSoftWrapsShown
```
boolean isAllSoftWrapsShown()
```
  - isUseCustomSoftWrapIndent
```
boolean isUseCustomSoftWrapIndent()
```
  - setUseCustomSoftWrapIndent
```
void setUseCustomSoftWrapIndent(boolean useCustomSoftWrapIndent)
```
  - getCustomSoftWrapIndent
```
int getCustomSoftWrapIndent()
```
  - setCustomSoftWrapIndent
```
void setCustomSoftWrapIndent(int indent)
```
  - isAllowSingleLogicalLineFolding
```
boolean isAllowSingleLogicalLineFolding()
```
    See Also:
    
    setAllowSingleLogicalLineFolding(boolean)
  - setAllowSingleLogicalLineFolding
```
void setAllowSingleLogicalLineFolding(boolean allow)
```
    By default, gutter mark (for collapsing/expanding the region using mouse) is not shown for a folding region, if it's contained within a single document line. If overridden by the call to this method, marks will be displayed for such a region if it occupies multiple visual lines (due to soft wrapping). Displaying a gutter mark can be also enabled for a region unconditionally using FoldRegion.setGutterMarkEnabledForSingleLine(boolean).
  - isPreselectRename
```
boolean isPreselectRename()
```
  - setPreselectRename
```
void setPreselectRename(boolean val)
```
  - isShowIntentionBulb
```
boolean isShowIntentionBulb()
```
  - setShowIntentionBulb
```
void setShowIntentionBulb(boolean show)
```
  - setLanguage
```
@Deprecated
default void setLanguage(Language language)
```
    Deprecated.
    
    Sets the language which determines certain editor settings (right margin and soft margins, 'wrap on reaching right margin').
    
    See Also:
    
    getRightMargin(Project), getSoftMargins(), isWrapWhenTypingReachesRightMargin(Project)
  - setLanguageSupplier
```
void setLanguageSupplier(java.util.function.Supplier<? extends Language> languageSupplier)
```

Interface EditorSettings

Method Summary

Method Detail

isRightMarginShown

setRightMarginShown

isWhitespacesShown

setWhitespacesShown

isLeadingWhitespaceShown

setLeadingWhitespaceShown

isInnerWhitespaceShown

setInnerWhitespaceShown

isTrailingWhitespaceShown

setTrailingWhitespaceShown

getRightMargin

setRightMargin

getSoftMargins

setSoftMargins

isWrapWhenTypingReachesRightMargin

setWrapWhenTypingReachesRightMargin

isLineNumbersShown

setLineNumbersShown

getAdditionalLinesCount

setAdditionalLinesCount

getAdditionalColumnsCount

setAdditionalColumnsCount

isLineMarkerAreaShown

setLineMarkerAreaShown

areGutterIconsShown

setGutterIconsShown

isFoldingOutlineShown

setFoldingOutlineShown

isAutoCodeFoldingEnabled

setAutoCodeFoldingEnabled

isUseTabCharacter

setUseTabCharacter

getTabSize

setTabSize

isSmartHome

setSmartHome

isVirtualSpace

setVirtualSpace

isCaretInsideTabs

setCaretInsideTabs

isBlinkCaret

setBlinkCaret

getCaretBlinkPeriod

setCaretBlinkPeriod

isBlockCursor

setBlockCursor

isCaretRowShown

setCaretRowShown

getLineCursorWidth

setLineCursorWidth

isAnimatedScrolling

setAnimatedScrolling

isCamelWords

setCamelWords

resetCamelWords

isAdditionalPageAtBottom

setAdditionalPageAtBottom

isDndEnabled

setDndEnabled

isWheelFontChangeEnabled

setWheelFontChangeEnabled

isMouseClickSelectionHonorsCamelWords

setMouseClickSelectionHonorsCamelWords

isVariableInplaceRenameEnabled

setVariableInplaceRenameEnabled

isRefrainFromScrolling

setRefrainFromScrolling

isIndentGuidesShown

setIndentGuidesShown

isUseSoftWraps

setUseSoftWraps

isAllSoftWrapsShown

isUseCustomSoftWrapIndent

setUseCustomSoftWrapIndent

getCustomSoftWrapIndent

setCustomSoftWrapIndent

isAllowSingleLogicalLineFolding