Package com.github.blutorange.primefaces.config.monacoeditor

Class EditorOptions

java.lang.Object
org.primefaces.json.JSONObject
com.github.blutorange.primefaces.config.monacoeditor.EditorOptions
All Implemented Interfaces:
Serializable
public class EditorOptions
extends org.primefaces.json.JSONObject
implements Serializable
See Also:
Serialized Form

  • Constructor Details

  • Method Details

    • getComments

      public EditorCommentsOptions getComments()
      Returns:
      Control the behaviour of comments in the editor.

    • setComments

      public EditorOptions setComments​(EditorCommentsOptions comments)
      Parameters:
      comments - Control the behaviour of comments in the editor.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getDimension

      public EditorDimension getDimension()
      Returns:
      The initial editor dimension (to avoid measuring the container).

    • setDimension

      public EditorOptions setDimension​(EditorDimension dimension)
      Parameters:
      dimension - The initial editor dimension (to avoid measuring the container).
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getFind

      public EditorFindOptions getFind()
      Returns:
      Control the behavior of the find widget.

    • setFind

      public EditorOptions setFind​(EditorFindOptions find)
      Parameters:
      find - Control the behavior of the find widget.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getGotoLocation

      public EditorGotoLocationOptions getGotoLocation()

    • setGotoLocation

      public EditorOptions setGotoLocation​(EditorGotoLocationOptions gotoLocation)

    • getHover

      public EditorHoverOptions getHover()
      Returns:
      Configure the editor's hover.

    • setHover

      public EditorOptions setHover​(EditorHoverOptions hover)
      Parameters:
      hover - Configure the editor's hover.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getLightbulb

      public EditorLightbulbOptions getLightbulb()
      Returns:
      Control the behavior and rendering of the code action lightbulb.

    • setLightbulb

      public EditorOptions setLightbulb​(EditorLightbulbOptions lightbulb)
      Parameters:
      lightbulb - Control the behavior and rendering of the code action lightbulb.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getMinimap

      public EditorMinimapOptions getMinimap()

    • setMinimap

      public EditorOptions setMinimap​(EditorMinimapOptions minimap)

    • isParameterHints

      public Boolean isParameterHints()

    • setParameterHints

      public EditorOptions setParameterHints​(Boolean parameterHints)

    • getQuickSuggestions

      public EditorQuickSuggestionsOptions getQuickSuggestions()
      Returns:
      Enable quick suggestions (shadow suggestions) Defaults to true

    • setQuickSuggestions

      public EditorOptions setQuickSuggestions​(EditorQuickSuggestionsOptions quickSuggestions)
      Parameters:
      quickSuggestions - Enable quick suggestions (shadow suggestions) Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getScrollbar

      public EditorScrollbarOptions getScrollbar()
      Returns:
      Control the behavior and rendering of the scrollbars.

    • setScrollbar

      public EditorOptions setScrollbar​(EditorScrollbarOptions scrollbar)
      Parameters:
      scrollbar - Control the behavior and rendering of the scrollbars.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getSuggest

      public EditorSuggestOptions getSuggest()
      Returns:
      Suggest options.

    • setSuggest

      public EditorOptions setSuggest​(EditorSuggestOptions suggest)
      Parameters:
      suggest - Suggest options.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getAutoClosingOvertype

      public String getAutoClosingOvertype()
      Returns:
      Options for typing over closing quotes or brackets.

    • setAutoClosingOvertype

      public EditorOptions setAutoClosingOvertype​(EAutoClosingOvertype autoClosingOvertype)
      Parameters:
      autoClosingOvertype - Options for typing over closing quotes or brackets.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setAutoClosingOvertype

      public EditorOptions setAutoClosingOvertype​(String autoClosingOvertype)

    • getAutoIndent

      public String getAutoIndent()
      Returns:
      Controls whether the editor should automatically adjust the indentation when users type, paste, move or indent lines. Defaults to advanced.

    • setAutoIndent

      public EditorOptions setAutoIndent​(EAutoIndent autoIndent)
      Parameters:
      autoIndent - Controls whether the editor should automatically adjust the indentation when users type, paste, move or indent lines. Defaults to advanced.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setAutoIndent

      public EditorOptions setAutoIndent​(String autoIndent)

    • getAcceptSuggestionOnEnter

      public String getAcceptSuggestionOnEnter()
      Returns:
      Accept suggestions on ENTER. Defaults to on.

    • setAcceptSuggestionOnEnter

      public EditorOptions setAcceptSuggestionOnEnter​(EAcceptSuggestionOnEnter acceptSuggestionOnEnter)
      Parameters:
      acceptSuggestionOnEnter - Accept suggestions on ENTER. Defaults to on.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setAcceptSuggestionOnEnter

      public EditorOptions setAcceptSuggestionOnEnter​(String acceptSuggestionOnEnter)

    • getAccessibilitySupport

      public String getAccessibilitySupport()
      Returns:
      Configure the editor's accessibility support. Defaults to auto. It is best to leave this to auto.

    • setAccessibilitySupport

      public EditorOptions setAccessibilitySupport​(EAccessibilitySupport accessibilitySupport)
      Parameters:
      accessibilitySupport - Configure the editor's accessibility support. Defaults to auto. It is best to leave this to auto.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setAccessibilitySupport

      public EditorOptions setAccessibilitySupport​(String accessibilitySupport)

    • isAutoClosingBrackets

      public Boolean isAutoClosingBrackets()
      Returns:
      Options for auto closing brackets. Defaults to language defined behavior.

    • setAutoClosingBrackets

      public EditorOptions setAutoClosingBrackets​(Boolean autoClosingBrackets)
      Parameters:
      autoClosingBrackets - Options for auto closing brackets. Defaults to language defined behavior.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getAutoClosingQuotes

      public String getAutoClosingQuotes()
      Returns:
      Options for auto closing quotes. Defaults to language defined behavior.

    • setAutoClosingQuotes

      public EditorOptions setAutoClosingQuotes​(EAutoClosingQuotes autoClosingQuotes)
      Parameters:
      autoClosingQuotes - Options for auto closing quotes. Defaults to language defined behavior.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setAutoClosingQuotes

      public EditorOptions setAutoClosingQuotes​(String autoClosingQuotes)

    • getAutoSurround

      public String getAutoSurround()
      Returns:
      Options for auto surrounding. Defaults to always allowing auto surrounding.

    • setAutoSurround

      public EditorOptions setAutoSurround​(EAutoSurround autoSurround)
      Parameters:
      autoSurround - Options for auto surrounding. Defaults to always allowing auto surrounding.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setAutoSurround

      public EditorOptions setAutoSurround​(String autoSurround)

    • getCursorBlinking

      public String getCursorBlinking()
      Returns:
      Control the cursor animation style, possible values are blink, smooth, phase, expand and solid. Defaults to blink.

    • setCursorBlinking

      public EditorOptions setCursorBlinking​(ECursorBlinking cursorBlinking)
      Parameters:
      cursorBlinking - Control the cursor animation style, possible values are blink, smooth, phase, expand and solid. Defaults to blink.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setCursorBlinking

      public EditorOptions setCursorBlinking​(String cursorBlinking)

    • getCursorStyle

      public String getCursorStyle()
      Returns:
      Control the cursor style, either block or line. Defaults to line.

    • setCursorStyle

      public EditorOptions setCursorStyle​(ECursorStyle cursorStyle)
      Parameters:
      cursorStyle - Control the cursor style, either block or line. Defaults to line.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setCursorStyle

      public EditorOptions setCursorStyle​(String cursorStyle)

    • getCursorSurroundingLinesStyle

      public String getCursorSurroundingLinesStyle()
      Returns:
      Controls when cursorSurroundingLines should be enforced Defaults to default, cursorSurroundingLines is not enforced when cursor position is changed by mouse.

    • setCursorSurroundingLinesStyle

      public EditorOptions setCursorSurroundingLinesStyle​(ECursorSurroundingLinesStyle cursorSurroundingLinesStyle)
      Parameters:
      cursorSurroundingLinesStyle - Controls when cursorSurroundingLines should be enforced Defaults to default, cursorSurroundingLines is not enforced when cursor position is changed by mouse.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setCursorSurroundingLinesStyle

      public EditorOptions setCursorSurroundingLinesStyle​(String cursorSurroundingLinesStyle)

    • getFoldingStrategy

      public String getFoldingStrategy()
      Returns:
      Selects the folding strategy. 'auto' uses the strategies contributed for the current document, 'indentation' uses the indentation based folding strategy. Defaults to 'auto'.

    • setFoldingStrategy

      public EditorOptions setFoldingStrategy​(EFoldingStrategy foldingStrategy)
      Parameters:
      foldingStrategy - Selects the folding strategy. 'auto' uses the strategies contributed for the current document, 'indentation' uses the indentation based folding strategy. Defaults to 'auto'.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setFoldingStrategy

      public EditorOptions setFoldingStrategy​(String foldingStrategy)

    • getFontWeight

      public String getFontWeight()
      Returns:
      The font weight

    • setFontWeight

      public EditorOptions setFontWeight​(EFontWeight fontWeight)
      Parameters:
      fontWeight - The font weight
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setFontWeight

      public EditorOptions setFontWeight​(String fontWeight)

    • getLanguage

      public String getLanguage()

    • setLanguage

      public EditorOptions setLanguage​(ELanguage language)
      Parameters:
      language - The initial language of the auto created model in the editor. To not create automatically a model, use model: null.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setLanguage

      public EditorOptions setLanguage​(String language)

    • getLineNumbers

      public String getLineNumbers()
      Returns:
      Control the rendering of line numbers. If it is a function, it will be invoked when rendering a line number and the return value will be rendered. Otherwise, if it is a truey, line numbers will be rendered normally (equivalent of using an identity function). Otherwise, line numbers will not be rendered. Defaults to on.

    • setLineNumbers

      public EditorOptions setLineNumbers​(ELineNumbers lineNumbers)
      Parameters:
      lineNumbers - Control the rendering of line numbers. If it is a function, it will be invoked when rendering a line number and the return value will be rendered. Otherwise, if it is a truey, line numbers will be rendered normally (equivalent of using an identity function). Otherwise, line numbers will not be rendered. Defaults to on.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setLineNumbers

      public EditorOptions setLineNumbers​(String lineNumbers)

    • getMatchBrackets

      public String getMatchBrackets()
      Returns:
      Enable highlighting of matching brackets. Defaults to always.

    • setMatchBrackets

      public EditorOptions setMatchBrackets​(EMatchBrackets matchBrackets)
      Parameters:
      matchBrackets - Enable highlighting of matching brackets. Defaults to always.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setMatchBrackets

      public EditorOptions setMatchBrackets​(String matchBrackets)

    • getMouseStyle

      public String getMouseStyle()
      Returns:
      Control the mouse pointer style, either 'text' or 'default' or 'copy' Defaults to text

    • setMouseStyle

      public EditorOptions setMouseStyle​(EMouseStyle mouseStyle)
      Parameters:
      mouseStyle - Control the mouse pointer style, either 'text' or 'default' or 'copy' Defaults to text
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setMouseStyle

      public EditorOptions setMouseStyle​(String mouseStyle)

    • getMultiCursorModifier

      public String getMultiCursorModifier()
      Returns:
      The modifier to be used to add multiple cursors with the mouse. Defaults to alt

    • setMultiCursorModifier

      public EditorOptions setMultiCursorModifier​(EMultiCursorModifier multiCursorModifier)
      Parameters:
      multiCursorModifier - The modifier to be used to add multiple cursors with the mouse. Defaults to alt
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setMultiCursorModifier

      public EditorOptions setMultiCursorModifier​(String multiCursorModifier)

    • getMultiCursorPaste

      public String getMultiCursorPaste()
      Returns:
      Configure the behaviour when pasting a text with the line count equal to the cursor count. Defaults to spread.

    • setMultiCursorPaste

      public EditorOptions setMultiCursorPaste​(EMultiCursorPaste multiCursorPaste)
      Parameters:
      multiCursorPaste - Configure the behaviour when pasting a text with the line count equal to the cursor count. Defaults to spread.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setMultiCursorPaste

      public EditorOptions setMultiCursorPaste​(String multiCursorPaste)

    • getPeekWidgetDefaultFocus

      public String getPeekWidgetDefaultFocus()
      Returns:
      Controls whether to focus the inline editor in the peek widget by default. Defaults to false.

    • setPeekWidgetDefaultFocus

      public EditorOptions setPeekWidgetDefaultFocus​(EPeekWidgetDefaultFocus peekWidgetDefaultFocus)
      Parameters:
      peekWidgetDefaultFocus - Controls whether to focus the inline editor in the peek widget by default. Defaults to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setPeekWidgetDefaultFocus

      public EditorOptions setPeekWidgetDefaultFocus​(String peekWidgetDefaultFocus)

    • getRenderLineHighlight

      public String getRenderLineHighlight()
      Returns:
      Enable rendering of current line highlight. Defaults to all.

    • setRenderLineHighlight

      public EditorOptions setRenderLineHighlight​(ERenderLineHighlight renderLineHighlight)
      Parameters:
      renderLineHighlight - Enable rendering of current line highlight. Defaults to all.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setRenderLineHighlight

      public EditorOptions setRenderLineHighlight​(String renderLineHighlight)

    • getRenderValidationDecorations

      public String getRenderValidationDecorations()
      Returns:
      Should the editor render validation decorations. Defaults to editable.

    • setRenderValidationDecorations

      public EditorOptions setRenderValidationDecorations​(ERenderValidationDecorations renderValidationDecorations)
      Parameters:
      renderValidationDecorations - Should the editor render validation decorations. Defaults to editable.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setRenderValidationDecorations

      public EditorOptions setRenderValidationDecorations​(String renderValidationDecorations)

    • getRenderWhitespace

      public String getRenderWhitespace()
      Returns:
      Enable rendering of whitespace. Defaults to none.

    • setRenderWhitespace

      public EditorOptions setRenderWhitespace​(ERenderWhitespace renderWhitespace)
      Parameters:
      renderWhitespace - Enable rendering of whitespace. Defaults to none.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setRenderWhitespace

      public EditorOptions setRenderWhitespace​(String renderWhitespace)

    • getShowFoldingControls

      public String getShowFoldingControls()
      Returns:
      Controls whether the fold actions in the gutter stay always visible or hide unless the mouse is over the gutter. Defaults to mouseover.

    • setShowFoldingControls

      public EditorOptions setShowFoldingControls​(EShowFoldingControls showFoldingControls)
      Parameters:
      showFoldingControls - Controls whether the fold actions in the gutter stay always visible or hide unless the mouse is over the gutter. Defaults to mouseover.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setShowFoldingControls

      public EditorOptions setShowFoldingControls​(String showFoldingControls)

    • getSnippetSuggestions

      public String getSnippetSuggestions()
      Returns:
      Enable snippet suggestions. Defaults to 'inline'.

    • setSnippetSuggestions

      public EditorOptions setSnippetSuggestions​(ESnippetSuggestions snippetSuggestions)
      Parameters:
      snippetSuggestions - Enable snippet suggestions. Defaults to 'inline'.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setSnippetSuggestions

      public EditorOptions setSnippetSuggestions​(String snippetSuggestions)

    • getSuggestSelection

      public String getSuggestSelection()
      Returns:
      Keep peek editors open even when double clicking their content or when hitting Escape. Defaults to false.

    • setSuggestSelection

      public EditorOptions setSuggestSelection​(ESuggestSelection suggestSelection)
      Parameters:
      suggestSelection - Keep peek editors open even when double clicking their content or when hitting Escape. Defaults to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setSuggestSelection

      public EditorOptions setSuggestSelection​(String suggestSelection)

    • getTabCompletion

      public String getTabCompletion()
      Returns:
      Enable tab completion.

    • setTabCompletion

      public EditorOptions setTabCompletion​(ETabCompletion tabCompletion)
      Parameters:
      tabCompletion - Enable tab completion.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setTabCompletion

      public EditorOptions setTabCompletion​(String tabCompletion)

    • getTheme

      public String getTheme()
      Returns:
      Initial theme to be used for rendering. The current out-of-the-box available themes are: 'vs' (default), 'vs-dark', 'hc-black'. You can create custom themes via monaco.editor.defineTheme. To switch a theme, use monaco.editor.setTheme

    • setTheme

      public EditorOptions setTheme​(ETheme theme)
      Parameters:
      theme - Initial theme to be used for rendering. The current out-of-the-box available themes are: 'vs' (default), 'vs-dark', 'hc-black'. You can create custom themes via monaco.editor.defineTheme. To switch a theme, use monaco.editor.setTheme
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setTheme

      public EditorOptions setTheme​(String theme)

    • getWordWrap

      public String getWordWrap()
      Returns:
      Control the wrapping of the editor. When wordWrap = off, the lines will never wrap. When wordWrap = on, the lines will wrap at the viewport width. When wordWrap = wordWrapColumn, the lines will wrap at wordWrapColumn. When wordWrap = bounded, the lines will wrap at min(viewport width, wordWrapColumn). Defaults to off.

    • setWordWrap

      public EditorOptions setWordWrap​(EWordWrap wordWrap)
      Parameters:
      wordWrap - Control the wrapping of the editor. When wordWrap = off, the lines will never wrap. When wordWrap = on, the lines will wrap at the viewport width. When wordWrap = wordWrapColumn, the lines will wrap at wordWrapColumn. When wordWrap = bounded, the lines will wrap at min(viewport width, wordWrapColumn). Defaults to off.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setWordWrap

      public EditorOptions setWordWrap​(String wordWrap)

    • getWrappingIndent

      public String getWrappingIndent()
      Returns:
      Control indentation of wrapped lines. Can be: none, same, indent or deepIndent. Defaults to same in vscode and to none in monaco-editor.

    • setWrappingIndent

      public EditorOptions setWrappingIndent​(EWrappingIndent wrappingIndent)
      Parameters:
      wrappingIndent - Control indentation of wrapped lines. Can be: none, same, indent or deepIndent. Defaults to same in vscode and to none in monaco-editor.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setWrappingIndent

      public EditorOptions setWrappingIndent​(String wrappingIndent)

    • getWrappingStrategy

      public String getWrappingStrategy()
      Returns:
      Controls the wrapping strategy to use. Defaults to simple.

    • setWrappingStrategy

      public EditorOptions setWrappingStrategy​(EWrappingStrategy wrappingStrategy)
      Parameters:
      wrappingStrategy - Controls the wrapping strategy to use. Defaults to simple.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setWrappingStrategy

      public EditorOptions setWrappingStrategy​(String wrappingStrategy)

    • getRulers

      public org.primefaces.json.JSONArray getRulers()
      Returns:
      Render vertical lines at the specified columns. Defaults to empty array.

    • setRulers

      public EditorOptions setRulers​(org.primefaces.json.JSONArray rulers)
      Parameters:
      rulers - Render vertical lines at the specified columns. Defaults to empty array.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • addRuler

      public EditorOptions addRuler​(Number... items)

    • setRulers

      public EditorOptions setRulers​(List<Number> rulers)

    • isAcceptSuggestionOnCommitCharacter

      public Boolean isAcceptSuggestionOnCommitCharacter()
      Returns:
      Accept suggestions on provider defined characters. Defaults to true .

    • setAcceptSuggestionOnCommitCharacter

      public EditorOptions setAcceptSuggestionOnCommitCharacter​(Boolean acceptSuggestionOnCommitCharacter)
      Parameters:
      acceptSuggestionOnCommitCharacter - Accept suggestions on provider defined characters. Defaults to true .
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isAutomaticLayout

      public Boolean isAutomaticLayout()
      Returns:
      Enable that the editor will install an interval to check if its container dom node size has changed. Enabling this might have a severe performance impact. Defaults to false.

    • setAutomaticLayout

      public EditorOptions setAutomaticLayout​(Boolean automaticLayout)
      Parameters:
      automaticLayout - Enable that the editor will install an interval to check if its container dom node size has changed. Enabling this might have a severe performance impact. Defaults to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isCodeLens

      public Boolean isCodeLens()
      Returns:
      Show code lens Defaults to true .

    • setCodeLens

      public EditorOptions setCodeLens​(Boolean codeLens)
      Parameters:
      codeLens - Show code lens Defaults to true .
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isColorDecorators

      public Boolean isColorDecorators()
      Returns:
      Enable inline color decorators and color picker rendering.

    • setColorDecorators

      public EditorOptions setColorDecorators​(Boolean colorDecorators)
      Parameters:
      colorDecorators - Enable inline color decorators and color picker rendering.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isContextmenu

      public Boolean isContextmenu()
      Returns:
      Enable custom contextmenu. Defaults to true .

    • setContextmenu

      public EditorOptions setContextmenu​(Boolean contextmenu)
      Parameters:
      contextmenu - Enable custom contextmenu. Defaults to true .
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isCopyWithSyntaxHighlighting

      public Boolean isCopyWithSyntaxHighlighting()
      Returns:
      Syntax highlighting is copied.

    • setCopyWithSyntaxHighlighting

      public EditorOptions setCopyWithSyntaxHighlighting​(Boolean copyWithSyntaxHighlighting)
      Parameters:
      copyWithSyntaxHighlighting - Syntax highlighting is copied.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isCursorSmoothCaretAnimation

      public Boolean isCursorSmoothCaretAnimation()
      Returns:
      Enable smooth caret animation. Defaults to false.

    • setCursorSmoothCaretAnimation

      public EditorOptions setCursorSmoothCaretAnimation​(Boolean cursorSmoothCaretAnimation)
      Parameters:
      cursorSmoothCaretAnimation - Enable smooth caret animation. Defaults to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isDetectIndentation

      public Boolean isDetectIndentation()
      Returns:
      Controls whether tabSize and insertSpaces will be automatically detected when a file is opened based on the file contents. Defaults to true .

    • setDetectIndentation

      public EditorOptions setDetectIndentation​(Boolean detectIndentation)
      Parameters:
      detectIndentation - Controls whether tabSize and insertSpaces will be automatically detected when a file is opened based on the file contents. Defaults to true .
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isDisableLayerHinting

      public Boolean isDisableLayerHinting()
      Returns:
      Disable the use of transform: translate3d(0px, 0px, 0px) for the editor margin and lines layers. The usage of transform: translate3d(0px, 0px, 0px) acts as a hint for browsers to create an extra layer. Defaults to false.

    • setDisableLayerHinting

      public EditorOptions setDisableLayerHinting​(Boolean disableLayerHinting)
      Parameters:
      disableLayerHinting - Disable the use of transform: translate3d(0px, 0px, 0px) for the editor margin and lines layers. The usage of transform: translate3d(0px, 0px, 0px) acts as a hint for browsers to create an extra layer. Defaults to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isDisableMonospaceOptimizations

      public Boolean isDisableMonospaceOptimizations()
      Returns:
      Disable the optimizations for monospace fonts. Defaults to false.

    • setDisableMonospaceOptimizations

      public EditorOptions setDisableMonospaceOptimizations​(Boolean disableMonospaceOptimizations)
      Parameters:
      disableMonospaceOptimizations - Disable the optimizations for monospace fonts. Defaults to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isDragAndDrop

      public Boolean isDragAndDrop()
      Returns:
      Controls if the editor should allow to move selections via drag and drop. Defaults to false.

    • setDragAndDrop

      public EditorOptions setDragAndDrop​(Boolean dragAndDrop)
      Parameters:
      dragAndDrop - Controls if the editor should allow to move selections via drag and drop. Defaults to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isEmptySelectionClipboard

      public Boolean isEmptySelectionClipboard()
      Returns:
      Copying without a selection copies the current line

    • setEmptySelectionClipboard

      public EditorOptions setEmptySelectionClipboard​(Boolean emptySelectionClipboard)
      Parameters:
      emptySelectionClipboard - Copying without a selection copies the current line
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isFixedOverflowWidgets

      public Boolean isFixedOverflowWidgets()
      Returns:
      Display overflow widgets as fixed. Defaults to false

    • setFixedOverflowWidgets

      public EditorOptions setFixedOverflowWidgets​(Boolean fixedOverflowWidgets)
      Parameters:
      fixedOverflowWidgets - Display overflow widgets as fixed. Defaults to false
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isFolding

      public Boolean isFolding()
      Returns:
      Enable code folding. Defaults to true

    • setFolding

      public EditorOptions setFolding​(Boolean folding)
      Parameters:
      folding - Enable code folding. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isFoldingHighlight

      public Boolean isFoldingHighlight()
      Returns:
      Enable highlight for folded regions. Defaults to true

    • setFoldingHighlight

      public EditorOptions setFoldingHighlight​(Boolean foldingHighlight)
      Parameters:
      foldingHighlight - Enable highlight for folded regions. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isFontLigatures

      public Boolean isFontLigatures()
      Returns:
      Enable font ligatures. Defaults to false

    • setFontLigatures

      public EditorOptions setFontLigatures​(Boolean fontLigatures)
      Parameters:
      fontLigatures - Enable font ligatures. Defaults to false
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isFormatOnPaste

      public Boolean isFormatOnPaste()
      Returns:
      Enable format on paste. Defaults to false

    • setFormatOnPaste

      public EditorOptions setFormatOnPaste​(Boolean formatOnPaste)
      Parameters:
      formatOnPaste - Enable format on paste. Defaults to false
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isFormatOnType

      public Boolean isFormatOnType()
      Returns:
      Enable format on type. Defaults to false

    • setFormatOnType

      public EditorOptions setFormatOnType​(Boolean formatOnType)
      Parameters:
      formatOnType - Enable format on type. Defaults to false
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isGlyphMargin

      public Boolean isGlyphMargin()
      Returns:
      Enable the rendering of the glyph margin. Defaults to true in vscode and to false in monaco-editor

    • setGlyphMargin

      public EditorOptions setGlyphMargin​(Boolean glyphMargin)
      Parameters:
      glyphMargin - Enable the rendering of the glyph margin. Defaults to true in vscode and to false in monaco-editor
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isHideCursorInOverviewRuler

      public Boolean isHideCursorInOverviewRuler()
      Returns:
      Should the cursor be hidden in the overview ruler. Defaults to false

    • setHideCursorInOverviewRuler

      public EditorOptions setHideCursorInOverviewRuler​(Boolean hideCursorInOverviewRuler)
      Parameters:
      hideCursorInOverviewRuler - Should the cursor be hidden in the overview ruler. Defaults to false
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isHighlightActiveIndentGuide

      public Boolean isHighlightActiveIndentGuide()
      Returns:
      Enable highlighting of the active indent guide. Defaults to true

    • setHighlightActiveIndentGuide

      public EditorOptions setHighlightActiveIndentGuide​(Boolean highlightActiveIndentGuide)
      Parameters:
      highlightActiveIndentGuide - Enable highlighting of the active indent guide. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isInsertSpaces

      public Boolean isInsertSpaces()
      Returns:
      Insert spaces when pressing Tab. This setting is overridden based on the file contents when detectIndentation is on. Defaults to true

    • setInsertSpaces

      public EditorOptions setInsertSpaces​(Boolean insertSpaces)
      Parameters:
      insertSpaces - Insert spaces when pressing Tab. This setting is overridden based on the file contents when detectIndentation is on. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isLargeFileOptimizations

      public Boolean isLargeFileOptimizations()
      Returns:
      Special handling for large files to disable certain memory intensive features. Defaults to true

    • setLargeFileOptimizations

      public EditorOptions setLargeFileOptimizations​(Boolean largeFileOptimizations)
      Parameters:
      largeFileOptimizations - Special handling for large files to disable certain memory intensive features. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isLinks

      public Boolean isLinks()
      Returns:
      Enable detecting links and making them clickable. Defaults to true

    • setLinks

      public EditorOptions setLinks​(Boolean links)
      Parameters:
      links - Enable detecting links and making them clickable. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isMouseWheelZoom

      public Boolean isMouseWheelZoom()
      Returns:
      Zoom the font in the editor when using the mouse wheel in combination with holding Ctrl. Defaults to false

    • setMouseWheelZoom

      public EditorOptions setMouseWheelZoom​(Boolean mouseWheelZoom)
      Parameters:
      mouseWheelZoom - Zoom the font in the editor when using the mouse wheel in combination with holding Ctrl. Defaults to false
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isMultiCursorMergeOverlapping

      public Boolean isMultiCursorMergeOverlapping()
      Returns:
      Merge overlapping selections. Defaults to true

    • setMultiCursorMergeOverlapping

      public EditorOptions setMultiCursorMergeOverlapping​(Boolean multiCursorMergeOverlapping)
      Parameters:
      multiCursorMergeOverlapping - Merge overlapping selections. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isOccurrencesHighlight

      public Boolean isOccurrencesHighlight()
      Returns:
      Enable semantic occurrences highlight. Defaults to true

    • setOccurrencesHighlight

      public EditorOptions setOccurrencesHighlight​(Boolean occurrencesHighlight)
      Parameters:
      occurrencesHighlight - Enable semantic occurrences highlight. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isOverviewRulerBorder

      public Boolean isOverviewRulerBorder()
      Returns:
      Controls if a border should be drawn around the overview ruler. Defaults to true

    • setOverviewRulerBorder

      public EditorOptions setOverviewRulerBorder​(Boolean overviewRulerBorder)
      Parameters:
      overviewRulerBorder - Controls if a border should be drawn around the overview ruler. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isReadOnly

      public Boolean isReadOnly()
      Returns:
      Should the editor be read only. Defaults to false

    • setReadOnly

      public EditorOptions setReadOnly​(Boolean readOnly)
      Parameters:
      readOnly - Should the editor be read only. Defaults to false
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isRenderControlCharacters

      public Boolean isRenderControlCharacters()
      Returns:
      Enable rendering of control characters. Defaults to false

    • setRenderControlCharacters

      public EditorOptions setRenderControlCharacters​(Boolean renderControlCharacters)
      Parameters:
      renderControlCharacters - Enable rendering of control characters. Defaults to false
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isRenderFinalNewline

      public Boolean isRenderFinalNewline()
      Returns:
      Render last line number when the file ends with a newline. Defaults to true

    • setRenderFinalNewline

      public EditorOptions setRenderFinalNewline​(Boolean renderFinalNewline)
      Parameters:
      renderFinalNewline - Render last line number when the file ends with a newline. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isRenderIndentGuides

      public Boolean isRenderIndentGuides()
      Returns:
      Enable rendering of indent guides. Defaults to true

    • setRenderIndentGuides

      public EditorOptions setRenderIndentGuides​(Boolean renderIndentGuides)
      Parameters:
      renderIndentGuides - Enable rendering of indent guides. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isRoundedSelection

      public Boolean isRoundedSelection()
      Returns:
      Render the editor selection with rounded borders. Defaults to true

    • setRoundedSelection

      public EditorOptions setRoundedSelection​(Boolean roundedSelection)
      Parameters:
      roundedSelection - Render the editor selection with rounded borders. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isScrollBeyondLastLine

      public Boolean isScrollBeyondLastLine()
      Returns:
      Enable that scrolling can go one screen size after the last line. Defaults to true

    • setScrollBeyondLastLine

      public EditorOptions setScrollBeyondLastLine​(Boolean scrollBeyondLastLine)
      Parameters:
      scrollBeyondLastLine - Enable that scrolling can go one screen size after the last line. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isSelectOnLineNumbers

      public Boolean isSelectOnLineNumbers()
      Returns:
      Should the corresponding line be selected when clicking on the line number? Defaults to true

    • setSelectOnLineNumbers

      public EditorOptions setSelectOnLineNumbers​(Boolean selectOnLineNumbers)
      Parameters:
      selectOnLineNumbers - Should the corresponding line be selected when clicking on the line number? Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isSelectionClipboard

      public Boolean isSelectionClipboard()
      Returns:
      Enable Linux primary clipboard. Defaults to true

    • setSelectionClipboard

      public EditorOptions setSelectionClipboard​(Boolean selectionClipboard)
      Parameters:
      selectionClipboard - Enable Linux primary clipboard. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isSelectionHighlight

      public Boolean isSelectionHighlight()
      Returns:
      Enable selection highlight. Defaults to true

    • setSelectionHighlight

      public EditorOptions setSelectionHighlight​(Boolean selectionHighlight)
      Parameters:
      selectionHighlight - Enable selection highlight. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowUnused

      public Boolean isShowUnused()
      Returns:
      Controls fading out of unused variables

    • setShowUnused

      public EditorOptions setShowUnused​(Boolean showUnused)
      Parameters:
      showUnused - Controls fading out of unused variables
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isSmoothScrolling

      public Boolean isSmoothScrolling()
      Returns:
      Enable that the editor animates scrolling to a position. Defaults to false

    • setSmoothScrolling

      public EditorOptions setSmoothScrolling​(Boolean smoothScrolling)
      Parameters:
      smoothScrolling - Enable that the editor animates scrolling to a position. Defaults to false
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isStablePeek

      public Boolean isStablePeek()
      Returns:
      Keep peek editors open even when double clicking their content or when hitting Escape. Defaults to false

    • setStablePeek

      public EditorOptions setStablePeek​(Boolean stablePeek)
      Parameters:
      stablePeek - Keep peek editors open even when double clicking their content or when hitting Escape. Defaults to false
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isSuggestOnTriggerCharacters

      public Boolean isSuggestOnTriggerCharacters()
      Returns:
      Enable the suggestion box to pop-up on trigger characters. Defaults to true

    • setSuggestOnTriggerCharacters

      public EditorOptions setSuggestOnTriggerCharacters​(Boolean suggestOnTriggerCharacters)
      Parameters:
      suggestOnTriggerCharacters - Enable the suggestion box to pop-up on trigger characters. Defaults to true
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isTrimAutoWhitespace

      public Boolean isTrimAutoWhitespace()
      Returns:
      Remove trailing auto inserted whitespace. Defaults to true .

    • setTrimAutoWhitespace

      public EditorOptions setTrimAutoWhitespace​(Boolean trimAutoWhitespace)
      Parameters:
      trimAutoWhitespace - Remove trailing auto inserted whitespace. Defaults to true .
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isUseTabStops

      public Boolean isUseTabStops()
      Returns:
      Inserting and deleting whitespace follows tab stops.

    • setUseTabStops

      public EditorOptions setUseTabStops​(Boolean useTabStops)
      Parameters:
      useTabStops - Inserting and deleting whitespace follows tab stops.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isWordBasedSuggestions

      public Boolean isWordBasedSuggestions()
      Returns:
      Controls whether completions should be computed based on words in the document. Defaults to true .

    • setWordBasedSuggestions

      public EditorOptions setWordBasedSuggestions​(Boolean wordBasedSuggestions)
      Parameters:
      wordBasedSuggestions - Controls whether completions should be computed based on words in the document. Defaults to true .
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isWordWrapMinified

      public Boolean isWordWrapMinified()
      Returns:
      Force word wrapping when the text appears to be of a minified/generated file. Defaults to true.

    • setWordWrapMinified

      public EditorOptions setWordWrapMinified​(Boolean wordWrapMinified)
      Parameters:
      wordWrapMinified - Force word wrapping when the text appears to be of a minified/generated file. Defaults to true.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getAccessibilityPageSize

      public Number getAccessibilityPageSize()
      Returns:
      Controls the number of lines in the editor that can be read out by a screen reader

    • setAccessibilityPageSize

      public EditorOptions setAccessibilityPageSize​(Number accessibilityPageSize)
      Parameters:
      accessibilityPageSize - Controls the number of lines in the editor that can be read out by a screen reader
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getCodeActionsOnSaveTimeout

      public Number getCodeActionsOnSaveTimeout()
      Returns:
      Timeout for running code actions on save.

    • setCodeActionsOnSaveTimeout

      public EditorOptions setCodeActionsOnSaveTimeout​(Number codeActionsOnSaveTimeout)
      Parameters:
      codeActionsOnSaveTimeout - Timeout for running code actions on save.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getCursorSurroundingLines

      public Number getCursorSurroundingLines()
      Returns:
      Controls the minimal number of visible leading and trailing lines surrounding the cursor. Defaults to 0.

    • setCursorSurroundingLines

      public EditorOptions setCursorSurroundingLines​(Number cursorSurroundingLines)
      Parameters:
      cursorSurroundingLines - Controls the minimal number of visible leading and trailing lines surrounding the cursor. Defaults to 0.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getCursorWidth

      public Number getCursorWidth()
      Returns:
      Control the width of the cursor when cursorStyle is set to line

    • setCursorWidth

      public EditorOptions setCursorWidth​(Number cursorWidth)
      Parameters:
      cursorWidth - Control the width of the cursor when cursorStyle is set to line
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getFastScrollSensitivity

      public Number getFastScrollSensitivity()
      Returns:
      FastScrolling mulitplier speed when pressing Alt Defaults to 5.

    • setFastScrollSensitivity

      public EditorOptions setFastScrollSensitivity​(Number fastScrollSensitivity)
      Parameters:
      fastScrollSensitivity - FastScrolling mulitplier speed when pressing Alt Defaults to 5.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getFontSize

      public Number getFontSize()
      Returns:
      The font size

    • setFontSize

      public EditorOptions setFontSize​(Number fontSize)
      Parameters:
      fontSize - The font size
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getLetterSpacing

      public Number getLetterSpacing()
      Returns:
      The letter spacing

    • setLetterSpacing

      public EditorOptions setLetterSpacing​(Number letterSpacing)
      Parameters:
      letterSpacing - The letter spacing
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getLineHeight

      public Number getLineHeight()
      Returns:
      The line height

    • setLineHeight

      public EditorOptions setLineHeight​(Number lineHeight)
      Parameters:
      lineHeight - The line height
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getLineNumbersMinChars

      public Number getLineNumbersMinChars()
      Returns:
      Control the rendering of line numbers. If it is a function, it will be invoked when rendering a line number and the return value will be rendered. Otherwise, if it is a truey, line numbers will be rendered normally (equivalent of using an identity function). Otherwise, line numbers will not be rendered. Defaults to on.

    • setLineNumbersMinChars

      public EditorOptions setLineNumbersMinChars​(Number lineNumbersMinChars)
      Parameters:
      lineNumbersMinChars - Control the rendering of line numbers. If it is a function, it will be invoked when rendering a line number and the return value will be rendered. Otherwise, if it is a truey, line numbers will be rendered normally (equivalent of using an identity function). Otherwise, line numbers will not be rendered. Defaults to on.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getMaxTokenizationLineLength

      public Number getMaxTokenizationLineLength()
      Returns:
      Lines above this length will not be tokenized for performance reasons. Defaults to 20000.

    • setMaxTokenizationLineLength

      public EditorOptions setMaxTokenizationLineLength​(Number maxTokenizationLineLength)
      Parameters:
      maxTokenizationLineLength - Lines above this length will not be tokenized for performance reasons. Defaults to 20000.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getMouseWheelScrollSensitivity

      public Number getMouseWheelScrollSensitivity()
      Returns:
      A multiplier to be used on the deltaX and deltaY of mouse wheel scroll events. Defaults to 1.

    • setMouseWheelScrollSensitivity

      public EditorOptions setMouseWheelScrollSensitivity​(Number mouseWheelScrollSensitivity)
      Parameters:
      mouseWheelScrollSensitivity - A multiplier to be used on the deltaX and deltaY of mouse wheel scroll events. Defaults to 1.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getOverviewRulerLanes

      public Number getOverviewRulerLanes()
      Returns:
      The number of vertical lanes the overview ruler should render. Defaults to 3.

    • setOverviewRulerLanes

      public EditorOptions setOverviewRulerLanes​(Number overviewRulerLanes)
      Parameters:
      overviewRulerLanes - The number of vertical lanes the overview ruler should render. Defaults to 3.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getQuickSuggestionsDelay

      public Number getQuickSuggestionsDelay()
      Returns:
      Quick suggestions show delay (in ms) Defaults to 10 (ms)

    • setQuickSuggestionsDelay

      public EditorOptions setQuickSuggestionsDelay​(Number quickSuggestionsDelay)
      Parameters:
      quickSuggestionsDelay - Quick suggestions show delay (in ms) Defaults to 10 (ms)
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getRevealHorizontalRightPadding

      public Number getRevealHorizontalRightPadding()
      Returns:
      When revealing the cursor, a virtual padding (px) is added to the cursor, turning it into a rectangle. This virtual padding ensures that the cursor gets revealed before hitting the edge of the viewport. Defaults to 30 (px).

    • setRevealHorizontalRightPadding

      public EditorOptions setRevealHorizontalRightPadding​(Number revealHorizontalRightPadding)
      Parameters:
      revealHorizontalRightPadding - When revealing the cursor, a virtual padding (px) is added to the cursor, turning it into a rectangle. This virtual padding ensures that the cursor gets revealed before hitting the edge of the viewport. Defaults to 30 (px).
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getScrollBeyondLastColumn

      public Number getScrollBeyondLastColumn()
      Returns:
      Enable that scrolling can go beyond the last column by a number of columns. Defaults to 5.

    • setScrollBeyondLastColumn

      public EditorOptions setScrollBeyondLastColumn​(Number scrollBeyondLastColumn)
      Parameters:
      scrollBeyondLastColumn - Enable that scrolling can go beyond the last column by a number of columns. Defaults to 5.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getStopRenderingLineAfter

      public Number getStopRenderingLineAfter()
      Returns:
      Performance guard: Stop rendering a line after x characters. Defaults to 10000. Use -1 to never stop rendering

    • setStopRenderingLineAfter

      public EditorOptions setStopRenderingLineAfter​(Number stopRenderingLineAfter)
      Parameters:
      stopRenderingLineAfter - Performance guard: Stop rendering a line after x characters. Defaults to 10000. Use -1 to never stop rendering
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getSuggestFontSize

      public Number getSuggestFontSize()
      Returns:
      The font size for the suggest widget. Defaults to the editor font size.

    • setSuggestFontSize

      public EditorOptions setSuggestFontSize​(Number suggestFontSize)
      Parameters:
      suggestFontSize - The font size for the suggest widget. Defaults to the editor font size.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getSuggestLineHeight

      public Number getSuggestLineHeight()
      Returns:
      The line height for the suggest widget. Defaults to the editor line height.

    • setSuggestLineHeight

      public EditorOptions setSuggestLineHeight​(Number suggestLineHeight)
      Parameters:
      suggestLineHeight - The line height for the suggest widget. Defaults to the editor line height.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getTabSize

      public Number getTabSize()
      Returns:
      The number of spaces a tab is equal to. This setting is overridden based on the file contents when detectIndentation is on. Defaults to 4.

    • setTabSize

      public EditorOptions setTabSize​(Number tabSize)
      Parameters:
      tabSize - The number of spaces a tab is equal to. This setting is overridden based on the file contents when detectIndentation is on. Defaults to 4.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getWordWrapColumn

      public Number getWordWrapColumn()
      Returns:
      Control the wrapping of the editor. When wordWrap = off, the lines will never wrap. When wordWrap = on, the lines will wrap at the viewport width. When wordWrap = wordWrapColumn, the lines will wrap at wordWrapColumn. When wordWrap = bounded, the lines will wrap at min(viewport width, wordWrapColumn). Defaults to 80.

    • setWordWrapColumn

      public EditorOptions setWordWrapColumn​(Number wordWrapColumn)
      Parameters:
      wordWrapColumn - Control the wrapping of the editor. When wordWrap = off, the lines will never wrap. When wordWrap = on, the lines will wrap at the viewport width. When wordWrap = wordWrapColumn, the lines will wrap at wordWrapColumn. When wordWrap = bounded, the lines will wrap at min(viewport width, wordWrapColumn). Defaults to 80.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getLineDecorationsWidth

      public String getLineDecorationsWidth()
      Returns:
      The width reserved for line decorations (in px). Line decorations are placed between line numbers and the editor content. You can pass in a string in the format floating point followed by ch. e.g. 1.3ch. Defaults to 10.

    • setLineDecorationsWidth

      public EditorOptions setLineDecorationsWidth​(Number lineDecorationsWidth)
      Parameters:
      lineDecorationsWidth - The width reserved for line decorations (in px). Line decorations are placed between line numbers and the editor content. You can pass in a string in the format floating point followed by ch. e.g. 1.3ch. Defaults to 10.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setLineDecorationsWidth

      public EditorOptions setLineDecorationsWidth​(String lineDecorationsWidth)

    • getAccessibilityHelpUrl

      public String getAccessibilityHelpUrl()
      Returns:
      An URL to open when Ctrl+H (Windows and Linux) or Cmd+H (OSX) is pressed in the accessibility help dialog in the editor.

    • setAccessibilityHelpUrl

      public EditorOptions setAccessibilityHelpUrl​(String accessibilityHelpUrl)
      Parameters:
      accessibilityHelpUrl - An URL to open when Ctrl+H (Windows and Linux) or Cmd+H (OSX) is pressed in the accessibility help dialog in the editor.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getAriaLabel

      public String getAriaLabel()
      Returns:
      The aria label for the editor's textarea (when it is focused).

    • setAriaLabel

      public EditorOptions setAriaLabel​(String ariaLabel)
      Parameters:
      ariaLabel - The aria label for the editor's textarea (when it is focused).
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getExtraEditorClassName

      public String getExtraEditorClassName()
      Returns:
      Class name to be added to the editor.

    • setExtraEditorClassName

      public EditorOptions setExtraEditorClassName​(String extraEditorClassName)
      Parameters:
      extraEditorClassName - Class name to be added to the editor.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getFontFamily

      public String getFontFamily()
      Returns:
      The font family

    • setFontFamily

      public EditorOptions setFontFamily​(String fontFamily)
      Parameters:
      fontFamily - The font family
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getWordSeparators

      public String getWordSeparators()
      Returns:
      A string containing the word separators used when doing word navigation. Defaults to `~!@#$%^&*()-=+[{]}|;:'",.<>/?

    • setWordSeparators

      public EditorOptions setWordSeparators​(String wordSeparators)
      Parameters:
      wordSeparators - A string containing the word separators used when doing word navigation. Defaults to `~!@#$%^&*()-=+[{]}|;:'",.<>/?
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getWordWrapBreakAfterCharacters

      public String getWordWrapBreakAfterCharacters()
      Returns:
      Configure word wrapping characters. A break will be introduced after these characters. Defaults to ' })]?|/&.,;¢°′″‰℃、。｡､￠，．：；？！％・･ゝゞヽヾーァィゥェォッャュョヮヵヶぁぃぅぇぉっゃゅょゎゕゖㇰㇱㇲㇳㇴㇵㇶㇷㇸㇹㇺㇻㇼㇽㇾㇿ々〻ｧｨｩｪｫｬｭｮｯｰ”〉》」』】〕）］｝｣'.

    • setWordWrapBreakAfterCharacters

      public EditorOptions setWordWrapBreakAfterCharacters​(String wordWrapBreakAfterCharacters)
      Parameters:
      wordWrapBreakAfterCharacters - Configure word wrapping characters. A break will be introduced after these characters. Defaults to ' })]?|/&.,;¢°′″‰℃、。｡､￠，．：；？！％・･ゝゞヽヾーァィゥェォッャュョヮヵヶぁぃぅぇぉっゃゅょゎゕゖㇰㇱㇲㇳㇴㇵㇶㇷㇸㇹㇺㇻㇼㇽㇾㇿ々〻ｧｨｩｪｫｬｭｮｯｰ”〉》」』】〕）］｝｣'.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getWordWrapBreakBeforeCharacters

      public String getWordWrapBreakBeforeCharacters()
      Returns:
      Configure word wrapping characters. A break will be introduced before these characters. Defaults to '([{‘“〈《「『【〔（［｛｢£¥＄￡￥+＋'.

    • setWordWrapBreakBeforeCharacters

      public EditorOptions setWordWrapBreakBeforeCharacters​(String wordWrapBreakBeforeCharacters)
      Parameters:
      wordWrapBreakBeforeCharacters - Configure word wrapping characters. A break will be introduced before these characters. Defaults to '([{‘“〈《「『【〔（［｛｢£¥＄￡￥+＋'.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.