Package org.primefaces.extensions.model.monacoeditor

Class EditorOptions

java.lang.Object
org.primefaces.shaded.json.JSONObject
org.primefaces.extensions.model.monacoeditor.EditorOptions
All Implemented Interfaces:
Serializable
public class EditorOptions extends org.primefaces.shaded.json.JSONObject implements Serializable
The options to create a Monaco Code editor instance.
See Also:

  • Constructor Details

    • EditorOptions

      public EditorOptions()

  • Method Details

    • getBracketPairColorization

      public EditorBracketPairColorizationOptions getBracketPairColorization()
      Returns:
      Configures bracket pair colorization (disabled by default).

    • setBracketPairColorization

      public EditorOptions setBracketPairColorization(EditorBracketPairColorizationOptions bracketPairColorization)
      Parameters:
      bracketPairColorization - Configures bracket pair colorization (disabled by default).
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getComments

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

    • setComments

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

    • getDropIntoEditor

      public EditorDropIntoEditorOptions getDropIntoEditor()
      Returns:
      Controls dropping into the editor from an external source. When enabled, this shows a preview of the drop location and triggers an onDropIntoEditor event.

    • setDropIntoEditor

      public EditorOptions setDropIntoEditor(EditorDropIntoEditorOptions dropIntoEditor)
      Parameters:
      dropIntoEditor - Controls dropping into the editor from an external source. When enabled, this shows a preview of the drop location and triggers an onDropIntoEditor event.
      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.

    • getGuides

      public EditorGuidesOptions getGuides()
      Returns:
      Controls the behavior of editor guides.

    • setGuides

      public EditorOptions setGuides(EditorGuidesOptions guides)
      Parameters:
      guides - Controls the behavior of editor guides.
      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.

    • getInlayHints

      public EditorInlayHintOptions getInlayHints()
      Returns:
      Control the behavior and rendering of the inline hints.

    • setInlayHints

      public EditorOptions setInlayHints(EditorInlayHintOptions inlayHints)
      Parameters:
      inlayHints - Control the behavior and rendering of the inline hints.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getInlineSuggest

      public EditorInlineSuggestOptions getInlineSuggest()
      Returns:
      Control the behavior and rendering of the inline completions.

    • setInlineSuggest

      public EditorOptions setInlineSuggest(EditorInlineSuggestOptions inlineSuggest)
      Parameters:
      inlineSuggest - Control the behavior and rendering of the inline completions.
      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()
      Returns:
      Control the behavior and rendering of the minimap.

    • setMinimap

      public EditorOptions setMinimap(EditorMinimapOptions minimap)
      Parameters:
      minimap - Control the behavior and rendering of the minimap.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getPadding

      public EditorPaddingOptions getPadding()
      Returns:
      Controls the spacing around the editor.

    • setPadding

      public EditorOptions setPadding(EditorPaddingOptions padding)
      Parameters:
      padding - Controls the spacing around the editor.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getParameterHints

      public EditorParameterHints getParameterHints()
      Returns:
      Parameter hint options.

    • setParameterHints

      public EditorOptions setParameterHints(EditorParameterHints parameterHints)
      Parameters:
      parameterHints - Parameter hint options.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

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

    • getPasteAs

      public EditorPasteAsOptions getPasteAs()
      Returns:
      Controls support for changing how content is pasted into the editor.

    • setPasteAs

      public EditorOptions setPasteAs(EditorPasteAsOptions pasteAs)
      Parameters:
      pasteAs - Controls support for changing how content is pasted into the editor.
      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.

    • getSmartSelect

      public EditorSmartSelectOptions getSmartSelect()
      Returns:
      Smart select options.

    • setSmartSelect

      public EditorOptions setSmartSelect(EditorSmartSelectOptions smartSelect)
      Parameters:
      smartSelect - Smart select options.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getStickyScroll

      public EditorStickyScrollOptions getStickyScroll()
      Returns:
      Control the behavior of sticky scroll options

    • setStickyScroll

      public EditorOptions setStickyScroll(EditorStickyScrollOptions stickyScroll)
      Parameters:
      stickyScroll - Control the behavior of sticky scroll options
      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.

    • getUnicodeHighlight

      public EditorUnicodeHighlightOptions getUnicodeHighlight()
      Returns:
      Controls the behavior of the unicode highlight feature (by default, ambiguous and invisible characters are highlighted).

    • setUnicodeHighlight

      public EditorOptions setUnicodeHighlight(EditorUnicodeHighlightOptions unicodeHighlight)
      Parameters:
      unicodeHighlight - Controls the behavior of the unicode highlight feature (by default, ambiguous and invisible characters are highlighted).
      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)
      Parameters:
      autoClosingOvertype - Options for typing over closing quotes or brackets.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

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

    • 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)
      Parameters:
      acceptSuggestionOnEnter - Accept suggestions on ENTER. Defaults to on.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

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

    • getAutoClosingBrackets

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

    • setAutoClosingBrackets

      public EditorOptions setAutoClosingBrackets(EAutoClosingBrackets 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.

    • setAutoClosingBrackets

      public EditorOptions setAutoClosingBrackets(String 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.

    • getAutoClosingDelete

      public String getAutoClosingDelete()
      Returns:
      Options for pressing backspace near quotes or bracket pairs.

    • setAutoClosingDelete

      public EditorOptions setAutoClosingDelete(EAutoClosingEditStrategy autoClosingDelete)
      Parameters:
      autoClosingDelete - Options for pressing backspace near quotes or bracket pairs.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setAutoClosingDelete

      public EditorOptions setAutoClosingDelete(String autoClosingDelete)
      Parameters:
      autoClosingDelete - Options for pressing backspace near quotes or bracket pairs.
      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)
      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.

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

    • getColorDecoratorsActivatedOn

      public String getColorDecoratorsActivatedOn()
      Returns:
      Controls what is the condition to spawn a color picker from a color decorator.

    • setColorDecoratorsActivatedOn

      public EditorOptions setColorDecoratorsActivatedOn(EColorDecoratorsActivatedOnMode colorDecoratorsActivatedOn)
      Parameters:
      colorDecoratorsActivatedOn - Controls what is the condition to spawn a color picker from a color decorator.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setColorDecoratorsActivatedOn

      public EditorOptions setColorDecoratorsActivatedOn(String colorDecoratorsActivatedOn)
      Parameters:
      colorDecoratorsActivatedOn - Controls what is the condition to spawn a color picker from a color decorator.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

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

    • getCursorSmoothCaretAnimation

      public String getCursorSmoothCaretAnimation()
      Returns:
      Enable smooth caret animation. Defaults to off.

    • setCursorSmoothCaretAnimation

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

    • setCursorSmoothCaretAnimation

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

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

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

    • getExperimentalWhitespaceRendering

      public String getExperimentalWhitespaceRendering()
      Returns:
      Enable experimental whitespace rendering. Defaults to svg.

    • setExperimentalWhitespaceRendering

      public EditorOptions setExperimentalWhitespaceRendering(EExperimentalWhitespaceRendering experimentalWhitespaceRendering)
      Parameters:
      experimentalWhitespaceRendering - Enable experimental whitespace rendering. Defaults to svg.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setExperimentalWhitespaceRendering

      public EditorOptions setExperimentalWhitespaceRendering(String experimentalWhitespaceRendering)
      Parameters:
      experimentalWhitespaceRendering - Enable experimental whitespace rendering. Defaults to svg.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

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

    • 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)
      Parameters:
      fontWeight - The font weight
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

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

    • 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)
      Parameters:
      matchBrackets - Enable highlighting of matching brackets. Defaults to always.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

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

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

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

    • getOccurrencesHighlight

      public String getOccurrencesHighlight()
      Returns:
      Enable semantic occurrences highlight. Defaults to singleFile.

    • setOccurrencesHighlight

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

    • setOccurrencesHighlight

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

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

    • getRenderFinalNewline

      public String getRenderFinalNewline()
      Returns:
      Render last line number when the file ends with a newline. Defaults to on for Windows and macOS and dimmed for Linux.

    • setRenderFinalNewline

      public EditorOptions setRenderFinalNewline(ERenderFinalNewline renderFinalNewline)
      Parameters:
      renderFinalNewline - Render last line number when the file ends with a newline. Defaults to on for Windows and macOS and dimmed for Linux.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setRenderFinalNewline

      public EditorOptions setRenderFinalNewline(String renderFinalNewline)
      Parameters:
      renderFinalNewline - Render last line number when the file ends with a newline. Defaults to on for Windows and macOS and dimmed for Linux.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • 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)
      Parameters:
      renderLineHighlight - Enable rendering of current line highlight. Defaults to all.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • 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)
      Parameters:
      renderValidationDecorations - Should the editor render validation decorations. Defaults to editable.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • 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)
      Parameters:
      renderWhitespace - Enable rendering of whitespace. Defaults to none.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

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

    • 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)
      Parameters:
      snippetSuggestions - Enable snippet suggestions. Defaults to 'inline'.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

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

    • 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)
      Parameters:
      tabCompletion - Enable tab completion.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getUnusualLineTerminators

      public String getUnusualLineTerminators()
      Returns:
      Remove unusual line terminators like LINE SEPARATOR (LS), PARAGRAPH SEPARATOR (PS). Defaults to prompt.

    • setUnusualLineTerminators

      public EditorOptions setUnusualLineTerminators(EUnusualLineTerminators unusualLineTerminators)
      Parameters:
      unusualLineTerminators - Remove unusual line terminators like LINE SEPARATOR (LS), PARAGRAPH SEPARATOR (PS). Defaults to prompt.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setUnusualLineTerminators

      public EditorOptions setUnusualLineTerminators(String unusualLineTerminators)
      Parameters:
      unusualLineTerminators - Remove unusual line terminators like LINE SEPARATOR (LS), PARAGRAPH SEPARATOR (PS). Defaults to prompt.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getWordBreak

      public String getWordBreak()
      Returns:
      Sets whether line breaks appear wherever the text would otherwise overflow its content box. When wordBreak = normal, Use the default line break rule. When wordBreak = keepAll, word breaks should not be used for Chinese/Japanese/Korean (CJK) text. Non-CJK text behavior is the same as for normal.

    • setWordBreak

      public EditorOptions setWordBreak(EWordBreak wordBreak)
      Parameters:
      wordBreak - Sets whether line breaks appear wherever the text would otherwise overflow its content box. When wordBreak = normal, Use the default line break rule. When wordBreak = keepAll, word breaks should not be used for Chinese/Japanese/Korean (CJK) text. Non-CJK text behavior is the same as for normal.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setWordBreak

      public EditorOptions setWordBreak(String wordBreak)
      Parameters:
      wordBreak - Sets whether line breaks appear wherever the text would otherwise overflow its content box. When wordBreak = normal, Use the default line break rule. When wordBreak = keepAll, word breaks should not be used for Chinese/Japanese/Korean (CJK) text. Non-CJK text behavior is the same as for normal.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

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

    • getWordWrapOverride1

      public String getWordWrapOverride1()
      Returns:
      Override the wordWrap setting.

    • setWordWrapOverride1

      public EditorOptions setWordWrapOverride1(EWordWrapOverride1 wordWrapOverride1)
      Parameters:
      wordWrapOverride1 - Override the wordWrap setting.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setWordWrapOverride1

      public EditorOptions setWordWrapOverride1(String wordWrapOverride1)
      Parameters:
      wordWrapOverride1 - Override the wordWrap setting.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getWordWrapOverride2

      public String getWordWrapOverride2()
      Returns:
      Override the wordWrapOverride1 setting.

    • setWordWrapOverride2

      public EditorOptions setWordWrapOverride2(EWordWrapOverride2 wordWrapOverride2)
      Parameters:
      wordWrapOverride2 - Override the wordWrapOverride1 setting.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setWordWrapOverride2

      public EditorOptions setWordWrapOverride2(String wordWrapOverride2)
      Parameters:
      wordWrapOverride2 - Override the wordWrapOverride1 setting.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

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

    • 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)
      Parameters:
      wrappingStrategy - Controls the wrapping strategy to use. Defaults to simple.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getRulers

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

    • setRulers

      public EditorOptions setRulers(org.primefaces.shaded.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(EditorRulerOption... items)
      Returns:
      Render vertical lines at the specified columns. Defaults to empty array.

    • setRulers

      public EditorOptions setRulers(List<EditorRulerOption> 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.

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

    • isAutoDetectHighContrast

      public Boolean isAutoDetectHighContrast()
      Returns:
      If enabled, will automatically change to high contrast theme if the OS is using a high contrast theme. Defaults to true.

    • setAutoDetectHighContrast

      public EditorOptions setAutoDetectHighContrast(Boolean autoDetectHighContrast)
      Parameters:
      autoDetectHighContrast - If enabled, will automatically change to high contrast theme if the OS is using a high contrast theme. 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.

    • isColorDecoratorsLimit

      public Boolean isColorDecoratorsLimit()
      Returns:
      Controls the max number of color decorators that can be rendered in an editor at once.

    • setColorDecoratorsLimit

      public EditorOptions setColorDecoratorsLimit(Boolean colorDecoratorsLimit)
      Parameters:
      colorDecoratorsLimit - Controls the max number of color decorators that can be rendered in an editor at once.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isColumnSelection

      public Boolean isColumnSelection()
      Returns:
      Enable that the selection with the mouse and keys is doing column selection. Defaults to false.

    • setColumnSelection

      public EditorOptions setColumnSelection(Boolean columnSelection)
      Parameters:
      columnSelection - Enable that the selection with the mouse and keys is doing column selection. Defaults to false.
      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.

    • isDefaultColorDecorators

      public Boolean isDefaultColorDecorators()
      Returns:
      Controls whether to use default color decorations or not using the default document color provider

    • setDefaultColorDecorators

      public EditorOptions setDefaultColorDecorators(Boolean defaultColorDecorators)
      Parameters:
      defaultColorDecorators - Controls whether to use default color decorations or not using the default document color provider
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isDefinitionLinkOpensInPeek

      public Boolean isDefinitionLinkOpensInPeek()
      Returns:
      Controls whether the definition link opens element in the peek widget. Defaults to false.

    • setDefinitionLinkOpensInPeek

      public EditorOptions setDefinitionLinkOpensInPeek(Boolean definitionLinkOpensInPeek)
      Parameters:
      definitionLinkOpensInPeek - Controls whether the definition link opens element in the peek widget. Defaults to false.
      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.

    • getExperimentalInlineEdit

      public EditorInlineEditOptions getExperimentalInlineEdit()

    • setExperimentalInlineEdit

      public EditorOptions setExperimentalInlineEdit(EditorInlineEditOptions experimentalInlineEdit)

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

    • isFoldingImportsByDefault

      public Boolean isFoldingImportsByDefault()
      Returns:
      Auto fold imports folding regions. Defaults to true.

    • setFoldingImportsByDefault

      public EditorOptions setFoldingImportsByDefault(Boolean foldingImportsByDefault)
      Parameters:
      foldingImportsByDefault - Auto fold imports folding regions. Defaults to true.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isFontLigatures

      public Boolean isFontLigatures()

    • getFontLigatures

      public String getFontLigatures()

    • setFontLigatures

      public EditorOptions setFontLigatures(Boolean fontLigatures)

    • setFontLigatures

      public EditorOptions setFontLigatures(String fontLigatures)

    • isFontVariations

      public Boolean isFontVariations()

    • getFontVariations

      public String getFontVariations()

    • setFontVariations

      public EditorOptions setFontVariations(Boolean fontVariations)

    • setFontVariations

      public EditorOptions setFontVariations(String fontVariations)

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

    • isInlineCompletionsAccessibilityVerbose

      public Boolean isInlineCompletionsAccessibilityVerbose()
      Returns:
      Controls whether the accessibility hint should be provided to screen reader users when an inline completion is shown.

    • setInlineCompletionsAccessibilityVerbose

      public EditorOptions setInlineCompletionsAccessibilityVerbose(Boolean inlineCompletionsAccessibilityVerbose)
      Parameters:
      inlineCompletionsAccessibilityVerbose - Controls whether the accessibility hint should be provided to screen reader users when an inline completion is shown.
      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.

    • isLinkedEditing

      public Boolean isLinkedEditing()
      Returns:
      Enables linked editing. Defaults to false.

    • setLinkedEditing

      public EditorOptions setLinkedEditing(Boolean linkedEditing)
      Parameters:
      linkedEditing - Enables linked editing. Defaults to false.
      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.

    • isMatchOnWordStartOnly

      public Boolean isMatchOnWordStartOnly()
      Returns:
      Controls whether suggestions allow matches in the middle of the word instead of only at the beginning

    • setMatchOnWordStartOnly

      public EditorOptions setMatchOnWordStartOnly(Boolean matchOnWordStartOnly)
      Parameters:
      matchOnWordStartOnly - Controls whether suggestions allow matches in the middle of the word instead of only at the beginning
      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.

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

    • isRenameOnType

      @Deprecated public Boolean isRenameOnType()
      Deprecated.
      Returns:
      Deprecated, use
      invalid reference 
      linkedEditing
      instead.

    • setRenameOnType

      @Deprecated public EditorOptions setRenameOnType(Boolean renameOnType)
      Deprecated.
      Parameters:
      renameOnType - Deprecated, use
      invalid reference 
      linkedEditing
      instead.
      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 true.

    • setRenderControlCharacters

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

    • isRenderLineHighlightOnlyWhenFocus

      public Boolean isRenderLineHighlightOnlyWhenFocus()
      Returns:
      Control if the current line highlight should be rendered only the editor is focused. Defaults to false.

    • setRenderLineHighlightOnlyWhenFocus

      public EditorOptions setRenderLineHighlightOnlyWhenFocus(Boolean renderLineHighlightOnlyWhenFocus)
      Parameters:
      renderLineHighlightOnlyWhenFocus - Control if the current line highlight should be rendered only the editor is focused. Defaults to false.
      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.

    • isScreenReaderAnnounceInlineSuggestion

      public Boolean isScreenReaderAnnounceInlineSuggestion()
      Returns:
      Control whether a screen reader announces inline suggestion content immediately.

    • setScreenReaderAnnounceInlineSuggestion

      public EditorOptions setScreenReaderAnnounceInlineSuggestion(Boolean screenReaderAnnounceInlineSuggestion)
      Parameters:
      screenReaderAnnounceInlineSuggestion - Control whether a screen reader announces inline suggestion content immediately.
      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.

    • isScrollPredominantAxis

      public Boolean isScrollPredominantAxis()
      Returns:
      Enable that the editor scrolls only the predominant axis. Prevents horizontal drift when scrolling vertically on a trackpad. Defaults to true.}

    • setScrollPredominantAxis

      public EditorOptions setScrollPredominantAxis(Boolean scrollPredominantAxis)
      Parameters:
      scrollPredominantAxis - Enable that the editor scrolls only the predominant axis. Prevents horizontal drift when scrolling vertically on a trackpad. 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.

    • isShowDeprecated

      public Boolean isShowDeprecated()
      Returns:
      Controls strikethrough deprecated variables.

    • setShowDeprecated

      public EditorOptions setShowDeprecated(Boolean showDeprecated)
      Parameters:
      showDeprecated - Controls strikethrough deprecated variables.
      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.

    • isTabFocusMode

      public Boolean isTabFocusMode()
      Returns:
      Controls whether the editor receives tabs or defers them to the workbench for navigation.

    • setTabFocusMode

      public EditorOptions setTabFocusMode(Boolean tabFocusMode)
      Parameters:
      tabFocusMode - Controls whether the editor receives tabs or defers them to the workbench for navigation.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isUnfoldOnClickAfterEndOfLine

      public Boolean isUnfoldOnClickAfterEndOfLine()
      Returns:
      Controls whether clicking on the empty content after a folded line will unfold the line. Defaults to false.

    • setUnfoldOnClickAfterEndOfLine

      public EditorOptions setUnfoldOnClickAfterEndOfLine(Boolean unfoldOnClickAfterEndOfLine)
      Parameters:
      unfoldOnClickAfterEndOfLine - Controls whether clicking on the empty content after a folded line will unfold the line. Defaults to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isUseShadowDOM

      public Boolean isUseShadowDOM()
      Returns:
      Control if the editor should use shadow DOM.

    • setUseShadowDOM

      public EditorOptions setUseShadowDOM(Boolean useShadowDOM)
      Parameters:
      useShadowDOM - Control if the editor should use shadow DOM.
      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.

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

    • getCodeLensFontSize

      public Number getCodeLensFontSize()
      Returns:
      Code lens font size. Default to 90% of the editor font size.

    • setCodeLensFontSize

      public EditorOptions setCodeLensFontSize(Number codeLensFontSize)
      Parameters:
      codeLensFontSize - Code lens font size. Default to 90% of the editor font size.
      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:
      Fast scrolling multiplier speed when pressing Alt Defaults to 5.

    • setFastScrollSensitivity

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

    • getFoldingMaximumRegions

      public Number getFoldingMaximumRegions()
      Returns:
      Maximum number of foldable regions. Defaults to 5000.

    • setFoldingMaximumRegions

      public EditorOptions setFoldingMaximumRegions(Number foldingMaximumRegions)
      Parameters:
      foldingMaximumRegions - Maximum number of foldable regions. Defaults to 5000.
      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.

    • isInDiffEditor

      public Boolean isInDiffEditor()
      Returns:
      This editor is used inside a diff editor.

    • setInDiffEditor

      public EditorOptions setInDiffEditor(Boolean inDiffEditor)
      Parameters:
      inDiffEditor - This editor is used inside a diff editor.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isStickyTabStops

      public Boolean isStickyTabStops()
      Returns:
      Emulate selection behaviour of tab characters when using spaces for indentation. This means selection will stick to tab stops.

    • setStickyTabStops

      public EditorOptions setStickyTabStops(Boolean stickyTabStops)
      Parameters:
      stickyTabStops - Emulate selection behaviour of tab characters when using spaces for indentation. This means selection will stick to tab stops.
      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.

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

    • getMultiCursorLimit

      public Number getMultiCursorLimit()
      Returns:
      Controls the max number of text cursors that can be in an active editor at once.

    • setMultiCursorLimit

      public EditorOptions setMultiCursorLimit(Number multiCursorLimit)
      Parameters:
      multiCursorLimit - Controls the max number of text cursors that can be in an active editor at once.
      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.

    • getTabIndex

      public Number getTabIndex()
      Returns:
      The tabindex property of the editor's textarea.

    • setTabIndex

      public EditorOptions setTabIndex(Number tabIndex)
      Parameters:
      tabIndex - The tabindex property of the editor's textarea.
      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()

    • setLineDecorationsWidth

      public EditorOptions setLineDecorationsWidth(Number lineDecorationsWidth)

    • setLineDecorationsWidth

      public EditorOptions setLineDecorationsWidth(String lineDecorationsWidth)

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

    • getCodeLensFontFamily

      public String getCodeLensFontFamily()
      Returns:
      Code lens font family. Defaults to editor font family.

    • setCodeLensFontFamily

      public EditorOptions setCodeLensFontFamily(String codeLensFontFamily)
      Parameters:
      codeLensFontFamily - Code lens font family. Defaults to editor font family.
      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.

    • getPlaceholder

      public String getPlaceholder()
      Returns:
      Sets a placeholder for the editor. If set, the placeholder is shown if the editor is empty.

    • setPlaceholder

      public EditorOptions setPlaceholder(String placeholder)
      Parameters:
      placeholder - Sets a placeholder for the editor. If set, the placeholder is shown if the editor is empty.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getWordSegmenterLocales

      public org.primefaces.shaded.json.JSONArray getWordSegmenterLocales()
      Returns:
      Locales used for segmenting lines into words when doing word related navigations or operations.<p>Specify the BCP 47 language tag of the word you wish to recognize (e.g., ja, zh-CN, zh-Hant-TW, etc.). Defaults to empty array

    • setWordSegmenterLocales

      public EditorOptions setWordSegmenterLocales(org.primefaces.shaded.json.JSONArray wordSegmenterLocales)
      Parameters:
      wordSegmenterLocales - Locales used for segmenting lines into words when doing word related navigations or operations.<p>Specify the BCP 47 language tag of the word you wish to recognize (e.g., ja, zh-CN, zh-Hant-TW, etc.). Defaults to empty array
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • addWordSegmenterLocale

      public EditorOptions addWordSegmenterLocale(String... items)
      Returns:
      Locales used for segmenting lines into words when doing word related navigations or operations.<p>Specify the BCP 47 language tag of the word you wish to recognize (e.g., ja, zh-CN, zh-Hant-TW, etc.). Defaults to empty array

    • setWordSegmenterLocales

      public EditorOptions setWordSegmenterLocales(List<String> wordSegmenterLocales)
      Parameters:
      wordSegmenterLocales - Locales used for segmenting lines into words when doing word related navigations or operations.<p>Specify the BCP 47 language tag of the word you wish to recognize (e.g., ja, zh-CN, zh-Hant-TW, etc.). Defaults to empty array
      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 tab stops, closing brackets and parentheses, and several other Unicode punctuation marks.

    • setWordWrapBreakAfterCharacters

      public EditorOptions setWordWrapBreakAfterCharacters(String wordWrapBreakAfterCharacters)
      Parameters:
      wordWrapBreakAfterCharacters - Configure word wrapping characters. A break will be introduced after these characters. Defaults to tab stops, closing brackets and parentheses, and several other Unicode punctuation marks.
      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 opening brackets and parentheses, and several other Unicode punctuation marks.

    • setWordWrapBreakBeforeCharacters

      public EditorOptions setWordWrapBreakBeforeCharacters(String wordWrapBreakBeforeCharacters)
      Parameters:
      wordWrapBreakBeforeCharacters - Configure word wrapping characters. A break will be introduced before these characters. Defaults to opening brackets and parentheses, and several other Unicode punctuation marks.
      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.

    • getLanguage

      public String getLanguage()
      Returns:
      The initial language of the auto created model in the editor. To not create automatically a model, use model: null.

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

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

    • getWordBasedSuggestions

      public String getWordBasedSuggestions()
      Returns:
      Controls whether completions should be computed based on words in the document. Defaults to currentDocument.

    • setWordBasedSuggestions

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

    • setWordBasedSuggestions

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

    • getSemanticHighlightingEnabled

      public String getSemanticHighlightingEnabled()
      Returns:
      Controls whether the semanticHighlighting is shown for the languages that support it. true: Semantic highlighting is enabled for all themes false: Semantic highlighting is disabled for all themes. configuredByTheme: Semantic highlighting is controlled by the current color theme's semanticHighlighting setting. Defaults to configuredByTheme.

    • setSemanticHighlightingEnabled

      public EditorOptions setSemanticHighlightingEnabled(ESemanticHighlightingEnabled semanticHighlightingEnabled)
      Parameters:
      semanticHighlightingEnabled - Controls whether the semanticHighlighting is shown for the languages that support it. true: Semantic highlighting is enabled for all themes false: Semantic highlighting is disabled for all themes. configuredByTheme: Semantic highlighting is controlled by the current color theme's semanticHighlighting setting. Defaults to configuredByTheme.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setSemanticHighlightingEnabled

      public EditorOptions setSemanticHighlightingEnabled(String semanticHighlightingEnabled)
      Parameters:
      semanticHighlightingEnabled - Controls whether the semanticHighlighting is shown for the languages that support it. true: Semantic highlighting is enabled for all themes false: Semantic highlighting is disabled for all themes. configuredByTheme: Semantic highlighting is controlled by the current color theme's semanticHighlighting setting. Defaults to configuredByTheme.
      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.

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

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

    • isWordBasedSuggestionsOnlySameLanguage

      public Boolean isWordBasedSuggestionsOnlySameLanguage()
      Returns:
      Controls whether word based completions should be included from opened documents of the same language or any language.

    • setWordBasedSuggestionsOnlySameLanguage

      public EditorOptions setWordBasedSuggestionsOnlySameLanguage(Boolean wordBasedSuggestionsOnlySameLanguage)
      Parameters:
      wordBasedSuggestionsOnlySameLanguage - Controls whether word based completions should be included from opened documents of the same language or any language.
      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.

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

    • getAccessibilityHelpUrl

      public String getAccessibilityHelpUrl()
      Returns:
      A 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 - A 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.