Package com.intellij.openapi.editor.impl

Class SettingsImpl

java.lang.Object

com.intellij.openapi.editor.impl.SettingsImpl

All Implemented Interfaces:

EditorSettings

public class SettingsImpl
extends java.lang.Object
implements EditorSettings

Constructor Summary

Constructors

Constructor and Description
SettingsImpl()

Method Summary

Modifier and Type	Method and Description
boolean	areGutterIconsShown()
int	getAdditionalColumnsCount()
int	getAdditionalLinesCount()
int	getCaretBlinkPeriod()
int	getCustomSoftWrapIndent()
Language	getLanguage()
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.
SoftWrapAppliancePlaces	getSoftWrapAppliancePlace() Deprecated. use EditorKind
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	reinitSettings()
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 val)
void	setBlockCursor(boolean val)
void	setCamelWords(boolean val)
void	setCaretBlinkPeriod(int blinkPeriod)
void	setCaretInsideTabs(boolean allow)
void	setCaretRowShown(boolean val)
void	setCustomSoftWrapIndent(int indent)
void	setDndEnabled(boolean val)
void	setFoldingOutlineShown(boolean val)
void	setGutterIconsShown(boolean val)
void	setIndentGuidesShown(boolean val)
void	setInnerWhitespaceShown(boolean val)
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 rightMargin)
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 val)
void	setVariableInplaceRenameEnabled(boolean val)
void	setVirtualSpace(boolean allow)
void	setWheelFontChangeEnabled(boolean val)
void	setWhitespacesShown(boolean val)
void	setWrapWhenTypingReachesRightMargin(boolean val)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.editor.EditorSettings

setLanguage

Constructor Detail

SettingsImpl

public SettingsImpl()

Method Detail

isRightMarginShown

public boolean isRightMarginShown()

Specified by:

isRightMarginShown in interface EditorSettings

setRightMarginShown

public void setRightMarginShown(boolean val)

Specified by:

setRightMarginShown in interface EditorSettings

isWhitespacesShown

public boolean isWhitespacesShown()

Specified by:

isWhitespacesShown in interface EditorSettings

setWhitespacesShown

public void setWhitespacesShown(boolean val)

Specified by:

setWhitespacesShown in interface EditorSettings

isLeadingWhitespaceShown

public boolean isLeadingWhitespaceShown()

Specified by:

isLeadingWhitespaceShown in interface EditorSettings

setLeadingWhitespaceShown

public void setLeadingWhitespaceShown(boolean val)

Specified by:

setLeadingWhitespaceShown in interface EditorSettings

isInnerWhitespaceShown

public boolean isInnerWhitespaceShown()

Specified by:

isInnerWhitespaceShown in interface EditorSettings

setInnerWhitespaceShown

public void setInnerWhitespaceShown(boolean val)

Specified by:

setInnerWhitespaceShown in interface EditorSettings

isTrailingWhitespaceShown

public boolean isTrailingWhitespaceShown()

Specified by:

isTrailingWhitespaceShown in interface EditorSettings

setTrailingWhitespaceShown

public void setTrailingWhitespaceShown(boolean val)

Specified by:

setTrailingWhitespaceShown in interface EditorSettings

isIndentGuidesShown

public boolean isIndentGuidesShown()

Specified by:

isIndentGuidesShown in interface EditorSettings

setIndentGuidesShown

public void setIndentGuidesShown(boolean val)

Specified by:

setIndentGuidesShown in interface EditorSettings

isLineNumbersShown

public boolean isLineNumbersShown()

Specified by:

isLineNumbersShown in interface EditorSettings

setLineNumbersShown

public void setLineNumbersShown(boolean val)

Specified by:

setLineNumbersShown in interface EditorSettings

areGutterIconsShown

public boolean areGutterIconsShown()

Specified by:

areGutterIconsShown in interface EditorSettings

setGutterIconsShown

public void setGutterIconsShown(boolean val)

Specified by:

setGutterIconsShown in interface EditorSettings

getRightMargin

public int getRightMargin(Project project)

Specified by:

getRightMargin in interface EditorSettings

isWrapWhenTypingReachesRightMargin

public boolean isWrapWhenTypingReachesRightMargin(Project project)

Specified by:

isWrapWhenTypingReachesRightMargin in interface EditorSettings

setWrapWhenTypingReachesRightMargin

public void setWrapWhenTypingReachesRightMargin(boolean val)

Specified by:

setWrapWhenTypingReachesRightMargin in interface EditorSettings

setRightMargin

public void setRightMargin(int rightMargin)

Specified by:

setRightMargin in interface EditorSettings

getSoftMargins

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

Description copied from interface: EditorSettings

Retrieves a list of soft margins (visual indent guides) to be used in the editor. If soft margins haven't been explicitly set with EditorSettings.setSoftMargins(List) method, they are obtained from code style settings: CodeStyleSettings.getSoftMargins().

Specified by:

getSoftMargins in interface EditorSettings

Returns:

A list of current editor soft margins. The list may be empty if no soft margins are defined.

setSoftMargins

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

Description copied from interface: EditorSettings

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.

Specified by:

setSoftMargins in interface EditorSettings

Parameters:

softMargins - A list of soft margins or null to use margins from code style settings.

getAdditionalLinesCount

public int getAdditionalLinesCount()

Specified by:

getAdditionalLinesCount in interface EditorSettings

setAdditionalLinesCount

public void setAdditionalLinesCount(int additionalLinesCount)

Specified by:

setAdditionalLinesCount in interface EditorSettings

getAdditionalColumnsCount

public int getAdditionalColumnsCount()

Specified by:

getAdditionalColumnsCount in interface EditorSettings

setAdditionalColumnsCount

public void setAdditionalColumnsCount(int additionalColumnsCount)

Specified by:

setAdditionalColumnsCount in interface EditorSettings

isLineMarkerAreaShown

public boolean isLineMarkerAreaShown()

Specified by:

isLineMarkerAreaShown in interface EditorSettings

setLineMarkerAreaShown

public void setLineMarkerAreaShown(boolean lineMarkerAreaShown)

Specified by:

setLineMarkerAreaShown in interface EditorSettings

isFoldingOutlineShown

public boolean isFoldingOutlineShown()

Specified by:

isFoldingOutlineShown in interface EditorSettings

setFoldingOutlineShown

public void setFoldingOutlineShown(boolean val)

Specified by:

setFoldingOutlineShown in interface EditorSettings

isAutoCodeFoldingEnabled

public boolean isAutoCodeFoldingEnabled()

Specified by:

isAutoCodeFoldingEnabled in interface EditorSettings

setAutoCodeFoldingEnabled

public void setAutoCodeFoldingEnabled(boolean val)

Specified by:

setAutoCodeFoldingEnabled in interface EditorSettings

isUseTabCharacter

public boolean isUseTabCharacter(Project project)

Specified by:

isUseTabCharacter in interface EditorSettings

setUseTabCharacter

public void setUseTabCharacter(boolean val)

Specified by:

setUseTabCharacter in interface EditorSettings

getSoftWrapAppliancePlace

@Deprecated
public SoftWrapAppliancePlaces getSoftWrapAppliancePlace()

Deprecated. use EditorKind

reinitSettings

public void reinitSettings()

getTabSize

public int getTabSize(Project project)

Specified by:

getTabSize in interface EditorSettings

setTabSize

public void setTabSize(int tabSize)

Specified by:

setTabSize in interface EditorSettings

isSmartHome

public boolean isSmartHome()

Specified by:

isSmartHome in interface EditorSettings

setSmartHome

public void setSmartHome(boolean val)

Specified by:

setSmartHome in interface EditorSettings

isVirtualSpace

public boolean isVirtualSpace()

Specified by:

isVirtualSpace in interface EditorSettings

setVirtualSpace

public void setVirtualSpace(boolean allow)

Specified by:

setVirtualSpace in interface EditorSettings

isAdditionalPageAtBottom

public boolean isAdditionalPageAtBottom()

Specified by:

isAdditionalPageAtBottom in interface EditorSettings

setAdditionalPageAtBottom

public void setAdditionalPageAtBottom(boolean val)

Specified by:

setAdditionalPageAtBottom in interface EditorSettings

isCaretInsideTabs

public boolean isCaretInsideTabs()

Specified by:

isCaretInsideTabs in interface EditorSettings

setCaretInsideTabs

public void setCaretInsideTabs(boolean allow)

Specified by:

setCaretInsideTabs in interface EditorSettings

isBlockCursor

public boolean isBlockCursor()

Specified by:

isBlockCursor in interface EditorSettings

setBlockCursor

public void setBlockCursor(boolean val)

Specified by:

setBlockCursor in interface EditorSettings

isCaretRowShown

public boolean isCaretRowShown()

Specified by:

isCaretRowShown in interface EditorSettings

setCaretRowShown

public void setCaretRowShown(boolean val)

Specified by:

setCaretRowShown in interface EditorSettings

getLineCursorWidth

public int getLineCursorWidth()

Specified by:

getLineCursorWidth in interface EditorSettings

setLineCursorWidth

public void setLineCursorWidth(int width)

Specified by:

setLineCursorWidth in interface EditorSettings

isAnimatedScrolling

public boolean isAnimatedScrolling()

Specified by:

isAnimatedScrolling in interface EditorSettings

setAnimatedScrolling

public void setAnimatedScrolling(boolean val)

Specified by:

setAnimatedScrolling in interface EditorSettings

isCamelWords

public boolean isCamelWords()

Specified by:

isCamelWords in interface EditorSettings

setCamelWords

public void setCamelWords(boolean val)

Specified by:

setCamelWords in interface EditorSettings

resetCamelWords

public void resetCamelWords()

Description copied from interface: EditorSettings

Allows to remove 'use camel words' setup specific to the current settings object (if any) and use the shared one.

Specified by:

resetCamelWords in interface EditorSettings

isBlinkCaret

public boolean isBlinkCaret()

Specified by:

isBlinkCaret in interface EditorSettings

setBlinkCaret

public void setBlinkCaret(boolean val)

Specified by:

setBlinkCaret in interface EditorSettings

getCaretBlinkPeriod

public int getCaretBlinkPeriod()

Specified by:

getCaretBlinkPeriod in interface EditorSettings

setCaretBlinkPeriod

public void setCaretBlinkPeriod(int blinkPeriod)

Specified by:

setCaretBlinkPeriod in interface EditorSettings

isDndEnabled

public boolean isDndEnabled()

Specified by:

isDndEnabled in interface EditorSettings

setDndEnabled

public void setDndEnabled(boolean val)

Specified by:

setDndEnabled in interface EditorSettings

isWheelFontChangeEnabled

public boolean isWheelFontChangeEnabled()

Specified by:

isWheelFontChangeEnabled in interface EditorSettings

setWheelFontChangeEnabled

public void setWheelFontChangeEnabled(boolean val)

Specified by:

setWheelFontChangeEnabled in interface EditorSettings

isMouseClickSelectionHonorsCamelWords

public boolean isMouseClickSelectionHonorsCamelWords()

Specified by:

isMouseClickSelectionHonorsCamelWords in interface EditorSettings

setMouseClickSelectionHonorsCamelWords

public void setMouseClickSelectionHonorsCamelWords(boolean val)

Specified by:

setMouseClickSelectionHonorsCamelWords in interface EditorSettings

isVariableInplaceRenameEnabled

public boolean isVariableInplaceRenameEnabled()

Specified by:

isVariableInplaceRenameEnabled in interface EditorSettings

setVariableInplaceRenameEnabled

public void setVariableInplaceRenameEnabled(boolean val)

Specified by:

setVariableInplaceRenameEnabled in interface EditorSettings

isRefrainFromScrolling

public boolean isRefrainFromScrolling()

Specified by:

isRefrainFromScrolling in interface EditorSettings

setRefrainFromScrolling

public void setRefrainFromScrolling(boolean b)

Specified by:

setRefrainFromScrolling in interface EditorSettings

isUseSoftWraps

public boolean isUseSoftWraps()

Specified by:

isUseSoftWraps in interface EditorSettings

setUseSoftWraps

public void setUseSoftWraps(boolean use)

Specified by:

setUseSoftWraps in interface EditorSettings

isAllSoftWrapsShown

public boolean isAllSoftWrapsShown()

Specified by:

isAllSoftWrapsShown in interface EditorSettings

isUseCustomSoftWrapIndent

public boolean isUseCustomSoftWrapIndent()

Specified by:

isUseCustomSoftWrapIndent in interface EditorSettings

setUseCustomSoftWrapIndent

public void setUseCustomSoftWrapIndent(boolean useCustomSoftWrapIndent)

Specified by:

setUseCustomSoftWrapIndent in interface EditorSettings

getCustomSoftWrapIndent

public int getCustomSoftWrapIndent()

Specified by:

getCustomSoftWrapIndent in interface EditorSettings

setCustomSoftWrapIndent

public void setCustomSoftWrapIndent(int indent)

Specified by:

setCustomSoftWrapIndent in interface EditorSettings

isAllowSingleLogicalLineFolding

public boolean isAllowSingleLogicalLineFolding()

Specified by:

isAllowSingleLogicalLineFolding in interface EditorSettings

See Also:

EditorSettings.setAllowSingleLogicalLineFolding(boolean)

setAllowSingleLogicalLineFolding

public void setAllowSingleLogicalLineFolding(boolean allow)

Description copied from interface: EditorSettings

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).

Specified by:

setAllowSingleLogicalLineFolding in interface EditorSettings

isPreselectRename

public boolean isPreselectRename()

Specified by:

isPreselectRename in interface EditorSettings

setPreselectRename

public void setPreselectRename(boolean val)

Specified by:

setPreselectRename in interface EditorSettings

isShowIntentionBulb

public boolean isShowIntentionBulb()

Specified by:

isShowIntentionBulb in interface EditorSettings

setShowIntentionBulb

public void setShowIntentionBulb(boolean show)

Specified by:

setShowIntentionBulb in interface EditorSettings

getLanguage

public Language getLanguage()

setLanguageSupplier

public void setLanguageSupplier(java.util.function.Supplier<? extends Language> languageSupplier)

Specified by:

setLanguageSupplier in interface EditorSettings