Package com.intellij.openapi.editor.ex

Class EditorSettingsExternalizable

java.lang.Object

com.intellij.openapi.editor.ex.EditorSettingsExternalizable

All Implemented Interfaces:

PersistentStateComponent<EditorSettingsExternalizable.OptionSet>

public final class EditorSettingsExternalizable
extends java.lang.Object
implements PersistentStateComponent<EditorSettingsExternalizable.OptionSet>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EditorSettingsExternalizable.OptionSet
static class	EditorSettingsExternalizable.OsSpecificState
static interface	EditorSettingsExternalizable.StripTrailingSpaces

Field Summary

Fields

Modifier and Type	Field and Description
static UINumericRange	BLINKING_RANGE
static java.lang.String	PROP_VIRTUAL_SPACE
static java.lang.String	STRIP_TRAILING_SPACES_CHANGED
static java.lang.String	STRIP_TRAILING_SPACES_NONE
static java.lang.String	STRIP_TRAILING_SPACES_WHOLE
static UINumericRange	TOOLTIPS_DELAY_RANGE

Constructor Summary

Constructors

Constructor and Description
EditorSettingsExternalizable()
EditorSettingsExternalizable(EditorSettingsExternalizable.OsSpecificState state)

Method Summary

Modifier and Type	Method and Description
boolean	addCaretsOnDoubleCtrl()
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
boolean	areGutterIconsShown()
int	getAdditionalLinesCount() Deprecated. Not used, to be removed in version 2021.1.
BidiTextDirection	getBidiTextDirection()
int	getBlinkPeriod()
int	getBlockIndent()
CaretStopOptions	getCaretStopOptions()
int	getCustomSoftWrapIndent()
static EditorSettingsExternalizable	getInstance()
EditorSettingsExternalizable.OptionSet	getOptions()
int	getQuickDocOnMouseOverElementDelayMillis() Deprecated. Use getTooltipsDelay() instead
java.lang.String	getSoftWrapFileMasks()
EditorSettingsExternalizable.OptionSet	getState()
java.lang.String	getStripTrailingSpaces()
int	getTooltipsDelay()
boolean	hasBreadcrumbSettings(java.lang.String languageID)
boolean	isAdditionalPageAtBottom()
boolean	isAllSoftWrapsShown()
boolean	isBlinkCaret()
boolean	isBlockCursor()
boolean	isBreadcrumbsAbove()
boolean	isBreadcrumbsShown()
boolean	isBreadcrumbsShownFor(java.lang.String languageID)
boolean	isCamelWords()
boolean	isCaretInsideTabs()
boolean	isCaretRowShown()
boolean	isDndEnabled()
boolean	isDocCommentRenderingEnabled()
boolean	isEnsureNewLineAtEOF()
boolean	isFocusMode()
boolean	isFoldingOutlineShown()
boolean	isIndentGuidesShown()
boolean	isInnerWhitespacesShown()
boolean	isKeepTrailingSpacesOnCaretLine()
boolean	isLeadingWhitespacesShown()
boolean	isLineNumbersShown()
boolean	isMouseClickSelectionHonorsCamelWords()
boolean	isPreselectRename()
boolean	isRefrainFromScrolling()
boolean	isRightMarginShown()
boolean	isShowInlineLocalDialog()
boolean	isShowInspectionWidget()
boolean	isShowIntentionBulb()
boolean	isShowNotificationAfterOptimizeImports()
boolean	isShowNotificationAfterReformat()
boolean	isShowParameterNameHints() Deprecated. use com.intellij.codeInsight.hints.HintUtilsKt#isParameterHintsEnabledForLanguage(Language) instead
boolean	isShowQuickDocOnMouseOverElement()
boolean	isSmartHome()
boolean	isSmoothScrolling()
boolean	isTrailingWhitespacesShown()
boolean	isUseCustomSoftWrapIndent()
boolean	isUseSoftWraps()
boolean	isUseSoftWraps(SoftWrapAppliancePlaces place)
boolean	isVariableInplaceRenameEnabled()
boolean	isVirtualSpace()
boolean	isWheelFontChangeEnabled()
boolean	isWhitespacesShown()
void	loadState(EditorSettingsExternalizable.OptionSet state) This method is called when new component state is loaded.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	resetDefaultBreadcrumbVisibility()
void	setAddCaretsOnDoubleCtrl(boolean val)
void	setAdditionalLinesCount(int additionalLinesCount) Deprecated. Not used, to be removed in version 2021.1.
void	setAdditionalPageAtBottom(boolean val)
void	setAllSoftwrapsShown(boolean val)
void	setBidiTextDirection(BidiTextDirection direction)
void	setBlinkCaret(boolean blinkCaret)
void	setBlinkPeriod(int blinkInterval)
void	setBlockCursor(boolean val)
void	setBlockIndent(int blockIndent)
boolean	setBreadcrumbsAbove(boolean value)
boolean	setBreadcrumbsShown(boolean value)
boolean	setBreadcrumbsShownFor(java.lang.String languageID, boolean value)
void	setCamelWords(boolean val)
void	setCaretInsideTabs(boolean val)
void	setCaretStopOptions(CaretStopOptions options)
void	setCustomSoftWrapIndent(int indent)
void	setDndEnabled(boolean val)
void	setDocCommentRenderingEnabled(boolean value)
void	setEnsureNewLineAtEOF(boolean ensure)
void	setFocusMode(boolean val)
void	setFoldingOutlineShown(boolean val)
void	setGutterIconsShown(boolean val)
void	setIndentGuidesShown(boolean val)
void	setInnerWhitespacesShown(boolean val)
void	setKeepTrailingSpacesOnCaretLine(boolean keep)
void	setLeadingWhitespacesShown(boolean val)
void	setLineNumbersShown(boolean val)
void	setMouseClickSelectionHonorsCamelWords(boolean val)
void	setPreselectRename(boolean val)
void	setRefrainFromScrolling(boolean b)
void	setRightMarginShown(boolean val)
void	setShowInlineLocalDialog(boolean val)
void	setShowInspectionWidget(boolean show)
void	setShowIntentionBulb(boolean show)
void	setShowNotificationAfterOptimizeImports(boolean b)
void	setShowNotificationAfterReformat(boolean b)
void	setShowParameterNameHints(boolean value) Deprecated. use com.intellij.codeInsight.hints.HintUtilsKt#setShowParameterHintsForLanguage(boolean, Language) instead
void	setShowQuickDocOnMouseOverElement(boolean show)
void	setSmartHome(boolean val)
void	setSmoothScrolling(boolean val)
void	setSoftWrapFileMasks(java.lang.String value)
void	setStripTrailingSpaces(java.lang.String stripTrailingSpaces)
void	setTooltipsDelay(int delay)
void	setTrailingWhitespacesShown(boolean val)
void	setUseCustomSoftWrapIndent(boolean use)
void	setUseSoftWraps(boolean use)
void	setUseSoftWraps(boolean use, SoftWrapAppliancePlaces place)
void	setVariableInplaceRenameEnabled(boolean val)
void	setVirtualSpace(boolean val)
void	setWheelFontChangeEnabled(boolean val)
void	setWhitespacesShown(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.components.PersistentStateComponent

initializeComponent, noStateLoaded

Field Detail

PROP_VIRTUAL_SPACE

public static final java.lang.String PROP_VIRTUAL_SPACE

See Also:

Constant Field Values

BLINKING_RANGE

public static final UINumericRange BLINKING_RANGE

TOOLTIPS_DELAY_RANGE

public static final UINumericRange TOOLTIPS_DELAY_RANGE

STRIP_TRAILING_SPACES_NONE

public static final java.lang.String STRIP_TRAILING_SPACES_NONE

See Also:

Constant Field Values

STRIP_TRAILING_SPACES_CHANGED

public static final java.lang.String STRIP_TRAILING_SPACES_CHANGED

See Also:

Constant Field Values

STRIP_TRAILING_SPACES_WHOLE

public static final java.lang.String STRIP_TRAILING_SPACES_WHOLE

See Also:

Constant Field Values

Constructor Detail

EditorSettingsExternalizable

public EditorSettingsExternalizable()

EditorSettingsExternalizable

public EditorSettingsExternalizable(EditorSettingsExternalizable.OsSpecificState state)

Method Detail

getInstance

public static EditorSettingsExternalizable getInstance()

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

getState

public EditorSettingsExternalizable.OptionSet getState()

Specified by:

getState in interface PersistentStateComponent<EditorSettingsExternalizable.OptionSet>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

loadState

public void loadState(EditorSettingsExternalizable.OptionSet state)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<EditorSettingsExternalizable.OptionSet>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

getOptions

public EditorSettingsExternalizable.OptionSet getOptions()

isRightMarginShown

public boolean isRightMarginShown()

setRightMarginShown

public void setRightMarginShown(boolean val)

isLineNumbersShown

public boolean isLineNumbersShown()

setLineNumbersShown

public void setLineNumbersShown(boolean val)

areGutterIconsShown

public boolean areGutterIconsShown()

setGutterIconsShown

public void setGutterIconsShown(boolean val)

getAdditionalLinesCount

@Deprecated
public int getAdditionalLinesCount()

Deprecated. Not used, to be removed in version 2021.1.

setAdditionalLinesCount

@Deprecated
public void setAdditionalLinesCount(int additionalLinesCount)

Deprecated. Not used, to be removed in version 2021.1.

isFoldingOutlineShown

public boolean isFoldingOutlineShown()

setFoldingOutlineShown

public void setFoldingOutlineShown(boolean val)

isBreadcrumbsAbove

public boolean isBreadcrumbsAbove()

Returns:

true if breadcrumbs should be shown above the editor, false otherwise

setBreadcrumbsAbove

public boolean setBreadcrumbsAbove(boolean value)

Parameters:

value - true if breadcrumbs should be shown above the editor, false otherwise

Returns:

true if an option was modified, false otherwise

isBreadcrumbsShown

public boolean isBreadcrumbsShown()

Returns:

true if breadcrumbs should be shown, false otherwise

setBreadcrumbsShown

public boolean setBreadcrumbsShown(boolean value)

Parameters:

value - true if breadcrumbs should be shown, false otherwise

Returns:

true if an option was modified, false otherwise

isBreadcrumbsShownFor

public boolean isBreadcrumbsShownFor(java.lang.String languageID)

Parameters:

languageID - the language identifier to configure

Returns:

true if breadcrumbs should be shown for the specified language, false otherwise

resetDefaultBreadcrumbVisibility

public void resetDefaultBreadcrumbVisibility()

hasBreadcrumbSettings

public boolean hasBreadcrumbSettings(java.lang.String languageID)

setBreadcrumbsShownFor

public boolean setBreadcrumbsShownFor(java.lang.String languageID,
                                      boolean value)

Parameters:

languageID - the language identifier to configure

value - true if breadcrumbs should be shown for the specified language, false otherwise

Returns:

true if an option was modified, false otherwise

isDocCommentRenderingEnabled

public boolean isDocCommentRenderingEnabled()

setDocCommentRenderingEnabled

public void setDocCommentRenderingEnabled(boolean value)

isBlockCursor

public boolean isBlockCursor()

setBlockCursor

public void setBlockCursor(boolean val)

isCaretRowShown

public boolean isCaretRowShown()

getBlockIndent

public int getBlockIndent()

setBlockIndent

public void setBlockIndent(int blockIndent)

isSmartHome

public boolean isSmartHome()

setSmartHome

public void setSmartHome(boolean val)

isUseSoftWraps

public boolean isUseSoftWraps()

isUseSoftWraps

public boolean isUseSoftWraps(SoftWrapAppliancePlaces place)

setUseSoftWraps

public void setUseSoftWraps(boolean use)

setUseSoftWraps

public void setUseSoftWraps(boolean use,
                            SoftWrapAppliancePlaces place)

isUseCustomSoftWrapIndent

public boolean isUseCustomSoftWrapIndent()

setUseCustomSoftWrapIndent

public void setUseCustomSoftWrapIndent(boolean use)

getCustomSoftWrapIndent

public int getCustomSoftWrapIndent()

setCustomSoftWrapIndent

public void setCustomSoftWrapIndent(int indent)

isVirtualSpace

public boolean isVirtualSpace()

setVirtualSpace

public void setVirtualSpace(boolean val)

isCaretInsideTabs

public boolean isCaretInsideTabs()

setCaretInsideTabs

public void setCaretInsideTabs(boolean val)

isBlinkCaret

public boolean isBlinkCaret()

setBlinkCaret

public void setBlinkCaret(boolean blinkCaret)

getBlinkPeriod

public int getBlinkPeriod()

setBlinkPeriod

public void setBlinkPeriod(int blinkInterval)

isEnsureNewLineAtEOF

public boolean isEnsureNewLineAtEOF()

setEnsureNewLineAtEOF

public void setEnsureNewLineAtEOF(boolean ensure)

getStripTrailingSpaces

public java.lang.String getStripTrailingSpaces()

setStripTrailingSpaces

public void setStripTrailingSpaces(java.lang.String stripTrailingSpaces)

isShowQuickDocOnMouseOverElement

public boolean isShowQuickDocOnMouseOverElement()

setShowQuickDocOnMouseOverElement

public void setShowQuickDocOnMouseOverElement(boolean show)

isShowInspectionWidget

public boolean isShowInspectionWidget()

setShowInspectionWidget

public void setShowInspectionWidget(boolean show)

getQuickDocOnMouseOverElementDelayMillis

@Deprecated
public int getQuickDocOnMouseOverElementDelayMillis()

Deprecated. Use getTooltipsDelay() instead

getTooltipsDelay

public int getTooltipsDelay()

setTooltipsDelay

public void setTooltipsDelay(int delay)

isShowIntentionBulb

public boolean isShowIntentionBulb()

setShowIntentionBulb

public void setShowIntentionBulb(boolean show)

isRefrainFromScrolling

public boolean isRefrainFromScrolling()

setRefrainFromScrolling

public void setRefrainFromScrolling(boolean b)

isShowNotificationAfterReformat

public boolean isShowNotificationAfterReformat()

setShowNotificationAfterReformat

public void setShowNotificationAfterReformat(boolean b)

isShowNotificationAfterOptimizeImports

public boolean isShowNotificationAfterOptimizeImports()

setShowNotificationAfterOptimizeImports

public void setShowNotificationAfterOptimizeImports(boolean b)

isWhitespacesShown

public boolean isWhitespacesShown()

setWhitespacesShown

public void setWhitespacesShown(boolean val)

isLeadingWhitespacesShown

public boolean isLeadingWhitespacesShown()

setLeadingWhitespacesShown

public void setLeadingWhitespacesShown(boolean val)

isInnerWhitespacesShown

public boolean isInnerWhitespacesShown()

setInnerWhitespacesShown

public void setInnerWhitespacesShown(boolean val)

isTrailingWhitespacesShown

public boolean isTrailingWhitespacesShown()

setTrailingWhitespacesShown

public void setTrailingWhitespacesShown(boolean val)

isAllSoftWrapsShown

public boolean isAllSoftWrapsShown()

setAllSoftwrapsShown

public void setAllSoftwrapsShown(boolean val)

isIndentGuidesShown

public boolean isIndentGuidesShown()

setIndentGuidesShown

public void setIndentGuidesShown(boolean val)

isFocusMode

public boolean isFocusMode()

setFocusMode

public void setFocusMode(boolean val)

isSmoothScrolling

public boolean isSmoothScrolling()

setSmoothScrolling

public void setSmoothScrolling(boolean val)

isCamelWords

public boolean isCamelWords()

setCamelWords

public void setCamelWords(boolean val)

isAdditionalPageAtBottom

public boolean isAdditionalPageAtBottom()

setAdditionalPageAtBottom

public void setAdditionalPageAtBottom(boolean val)

isDndEnabled

public boolean isDndEnabled()

setDndEnabled

public void setDndEnabled(boolean val)

isWheelFontChangeEnabled

public boolean isWheelFontChangeEnabled()

setWheelFontChangeEnabled

public void setWheelFontChangeEnabled(boolean val)

isMouseClickSelectionHonorsCamelWords

public boolean isMouseClickSelectionHonorsCamelWords()

setMouseClickSelectionHonorsCamelWords

public void setMouseClickSelectionHonorsCamelWords(boolean val)

isVariableInplaceRenameEnabled

public boolean isVariableInplaceRenameEnabled()

setVariableInplaceRenameEnabled

public void setVariableInplaceRenameEnabled(boolean val)

isPreselectRename

public boolean isPreselectRename()

setPreselectRename

public void setPreselectRename(boolean val)

isShowInlineLocalDialog

public boolean isShowInlineLocalDialog()

setShowInlineLocalDialog

public void setShowInlineLocalDialog(boolean val)

addCaretsOnDoubleCtrl

public boolean addCaretsOnDoubleCtrl()

setAddCaretsOnDoubleCtrl

public void setAddCaretsOnDoubleCtrl(boolean val)

getBidiTextDirection

public BidiTextDirection getBidiTextDirection()

setBidiTextDirection

public void setBidiTextDirection(BidiTextDirection direction)

isShowParameterNameHints

@Deprecated
public boolean isShowParameterNameHints()

Deprecated. use com.intellij.codeInsight.hints.HintUtilsKt#isParameterHintsEnabledForLanguage(Language) instead

setShowParameterNameHints

@Deprecated
public void setShowParameterNameHints(boolean value)

Deprecated. use com.intellij.codeInsight.hints.HintUtilsKt#setShowParameterHintsForLanguage(boolean, Language) instead

isKeepTrailingSpacesOnCaretLine

public boolean isKeepTrailingSpacesOnCaretLine()

setKeepTrailingSpacesOnCaretLine

public void setKeepTrailingSpacesOnCaretLine(boolean keep)

getSoftWrapFileMasks

public java.lang.String getSoftWrapFileMasks()

setSoftWrapFileMasks

public void setSoftWrapFileMasks(java.lang.String value)

getCaretStopOptions

public CaretStopOptions getCaretStopOptions()

setCaretStopOptions

public void setCaretStopOptions(CaretStopOptions options)