Package org.primefaces.extensions.model.monacoeditor

Class EditorOptions

  • All Implemented Interfaces:
    java.io.Serializable
    public class EditorOptions
extends org.primefaces.shaded.json.JSONObject
implements java.io.Serializable
    The options to create a Monaco Code editor instance.
    See Also:
    Serialized Form

    • Constructor Detail

      • EditorOptions

        public EditorOptions()

    • Method Detail

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

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

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

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

      • setSmartSelect

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

      • 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:
        Defines how Unicode characters should be highlighted.

      • setUnicodeHighlight

        public EditorOptions setUnicodeHighlight​(EditorUnicodeHighlightOptions unicodeHighlight)
        Parameters:
        unicodeHighlight - Defines how Unicode characters should be highlighted.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.

      • getAutoClosingOvertype

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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.

      • getCursorBlinking

        public java.lang.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​(java.lang.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.

      • getCursorStyle

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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.

      • getFoldingStrategy

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

      • getLineNumbers

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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.

      • getPeekWidgetDefaultFocus

        public java.lang.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​(java.lang.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.

      • getRenderLineHighlight

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

      • getUnusualLineTerminators

        public java.lang.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​(java.lang.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.

      • getWordWrap

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.String wordWrapOverride1)
        Parameters:
        wordWrapOverride1 - Override the wordWrap setting.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.

      • getWordWrapOverride2

        public java.lang.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​(java.lang.String wordWrapOverride2)
        Parameters:
        wordWrapOverride2 - Override the wordWrapOverride1 setting.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.

      • getWrappingIndent

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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​(java.util.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 java.lang.Boolean isAcceptSuggestionOnCommitCharacter()
        Returns:
        Accept suggestions on provider defined characters. Defaults to true.

      • setAcceptSuggestionOnCommitCharacter

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

      • isAutomaticLayout

        public java.lang.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​(java.lang.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 java.lang.Boolean isCodeLens()
        Returns:
        Show code lens Defaults to true.

      • setCodeLens

        public EditorOptions setCodeLens​(java.lang.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 java.lang.Boolean isColorDecorators()
        Returns:
        Enable inline color decorators and color picker rendering.

      • setColorDecorators

        public EditorOptions setColorDecorators​(java.lang.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.

      • isColumnSelection

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

      • setColumnSelection

        public EditorOptions setColumnSelection​(java.lang.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 java.lang.Boolean isContextmenu()
        Returns:
        Enable custom contextmenu. Defaults to true.

      • setContextmenu

        public EditorOptions setContextmenu​(java.lang.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 java.lang.Boolean isCopyWithSyntaxHighlighting()
        Returns:
        Syntax highlighting is copied.

      • setCopyWithSyntaxHighlighting

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

      • isCursorSmoothCaretAnimation

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

      • setCursorSmoothCaretAnimation

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

      • isDefinitionLinkOpensInPeek

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

      • setDefinitionLinkOpensInPeek

        public EditorOptions setDefinitionLinkOpensInPeek​(java.lang.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 java.lang.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​(java.lang.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 java.lang.Boolean isDisableMonospaceOptimizations()
        Returns:
        Disable the optimizations for monospace fonts. Defaults to false.

      • setDisableMonospaceOptimizations

        public EditorOptions setDisableMonospaceOptimizations​(java.lang.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 java.lang.Boolean isDragAndDrop()
        Returns:
        Controls if the editor should allow to move selections via drag and drop. Defaults to false.

      • setDragAndDrop

        public EditorOptions setDragAndDrop​(java.lang.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 java.lang.Boolean isEmptySelectionClipboard()
        Returns:
        Copying without a selection copies the current line

      • setEmptySelectionClipboard

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

      • isFixedOverflowWidgets

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

      • setFixedOverflowWidgets

        public EditorOptions setFixedOverflowWidgets​(java.lang.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 java.lang.Boolean isFolding()
        Returns:
        Enable code folding. Defaults to true.

      • setFolding

        public EditorOptions setFolding​(java.lang.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 java.lang.Boolean isFoldingHighlight()
        Returns:
        Enable highlight for folded regions. Defaults to true.

      • setFoldingHighlight

        public EditorOptions setFoldingHighlight​(java.lang.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 java.lang.Boolean isFoldingImportsByDefault()
        Returns:
        Auto fold imports folding regions. Defaults to true.

      • setFoldingImportsByDefault

        public EditorOptions setFoldingImportsByDefault​(java.lang.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 java.lang.Boolean isFontLigatures()
        Returns:
        Enable font ligatures. Defaults to false

      • setFontLigatures

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

      • isFormatOnPaste

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

      • setFormatOnPaste

        public EditorOptions setFormatOnPaste​(java.lang.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 java.lang.Boolean isFormatOnType()
        Returns:
        Enable format on type. Defaults to false

      • setFormatOnType

        public EditorOptions setFormatOnType​(java.lang.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 java.lang.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​(java.lang.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 java.lang.Boolean isHideCursorInOverviewRuler()
        Returns:
        Should the cursor be hidden in the overview ruler. Defaults to false

      • setHideCursorInOverviewRuler

        public EditorOptions setHideCursorInOverviewRuler​(java.lang.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.

      • isLargeFileOptimizations

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

      • setLargeFileOptimizations

        public EditorOptions setLargeFileOptimizations​(java.lang.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 java.lang.Boolean isLinkedEditing()
        Returns:
        Enables linked editing. Defaults to false.

      • setLinkedEditing

        public EditorOptions setLinkedEditing​(java.lang.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 java.lang.Boolean isLinks()
        Returns:
        Enable detecting links and making them clickable. Defaults to true.

      • setLinks

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

      • isMouseWheelZoom

        public java.lang.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​(java.lang.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 java.lang.Boolean isMultiCursorMergeOverlapping()
        Returns:
        Merge overlapping selections. Defaults to true.

      • setMultiCursorMergeOverlapping

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

      • isOccurrencesHighlight

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

      • setOccurrencesHighlight

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

      • isOverviewRulerBorder

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

      • setOverviewRulerBorder

        public EditorOptions setOverviewRulerBorder​(java.lang.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 java.lang.Boolean isReadOnly()
        Returns:
        Should the editor be read only. Defaults to false

      • setReadOnly

        public EditorOptions setReadOnly​(java.lang.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 java.lang.Boolean isRenameOnType()
        Deprecated.
        Returns:
        Deprecated, use linkedEditing instead.

      • setRenameOnType

        @Deprecated
public EditorOptions setRenameOnType​(java.lang.Boolean renameOnType)
        Deprecated.
        Parameters:
        renameOnType - Deprecated, use linkedEditing instead.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.

      • isRenderControlCharacters

        public java.lang.Boolean isRenderControlCharacters()
        Returns:
        Enable rendering of control characters. Defaults to true.

      • setRenderControlCharacters

        public EditorOptions setRenderControlCharacters​(java.lang.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.

      • isRenderFinalNewline

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

      • setRenderFinalNewline

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

      • isRenderLineHighlightOnlyWhenFocus

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

      • setRenderLineHighlightOnlyWhenFocus

        public EditorOptions setRenderLineHighlightOnlyWhenFocus​(java.lang.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 java.lang.Boolean isRoundedSelection()
        Returns:
        Render the editor selection with rounded borders. Defaults to true.

      • setRoundedSelection

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

      • isScrollBeyondLastLine

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

      • setScrollBeyondLastLine

        public EditorOptions setScrollBeyondLastLine​(java.lang.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 java.lang.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​(java.lang.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 java.lang.Boolean isSelectOnLineNumbers()
        Returns:
        Should the corresponding line be selected when clicking on the line number? Defaults to true.

      • setSelectOnLineNumbers

        public EditorOptions setSelectOnLineNumbers​(java.lang.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 java.lang.Boolean isSelectionClipboard()
        Returns:
        Enable Linux primary clipboard. Defaults to true.

      • setSelectionClipboard

        public EditorOptions setSelectionClipboard​(java.lang.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 java.lang.Boolean isSelectionHighlight()
        Returns:
        Enable selection highlight. Defaults to true.

      • setSelectionHighlight

        public EditorOptions setSelectionHighlight​(java.lang.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 java.lang.Boolean isShowDeprecated()
        Returns:
        Controls strikethrough deprecated variables.

      • setShowDeprecated

        public EditorOptions setShowDeprecated​(java.lang.Boolean showDeprecated)
        Parameters:
        showDeprecated - Controls strikethrough deprecated variables.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.

      • isShowUnused

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

      • setShowUnused

        public EditorOptions setShowUnused​(java.lang.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 java.lang.Boolean isSmoothScrolling()
        Returns:
        Enable that the editor animates scrolling to a position. Defaults to false

      • setSmoothScrolling

        public EditorOptions setSmoothScrolling​(java.lang.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 java.lang.Boolean isStablePeek()
        Returns:
        Keep peek editors open even when double clicking their content or when hitting Escape. Defaults to false

      • setStablePeek

        public EditorOptions setStablePeek​(java.lang.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 java.lang.Boolean isSuggestOnTriggerCharacters()
        Returns:
        Enable the suggestion box to pop-up on trigger characters. Defaults to true.

      • setSuggestOnTriggerCharacters

        public EditorOptions setSuggestOnTriggerCharacters​(java.lang.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.

      • isUnfoldOnClickAfterEndOfLine

        public java.lang.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​(java.lang.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 java.lang.Boolean isUseShadowDOM()
        Returns:
        Control if the editor should use shadow DOM.

      • setUseShadowDOM

        public EditorOptions setUseShadowDOM​(java.lang.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 java.lang.Boolean isUseTabStops()
        Returns:
        Inserting and deleting whitespace follows tab stops.

      • setUseTabStops

        public EditorOptions setUseTabStops​(java.lang.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 java.lang.Boolean isWordWrapMinified()
        Returns:
        Force word wrapping when the text appears to be of a minified/generated file. Defaults to true.

      • setWordWrapMinified

        public EditorOptions setWordWrapMinified​(java.lang.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 java.lang.Number getAccessibilityPageSize()
        Returns:
        Controls the number of lines in the editor that can be read out by a screen reader.

      • setAccessibilityPageSize

        public EditorOptions setAccessibilityPageSize​(java.lang.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 java.lang.Number getCodeActionsOnSaveTimeout()
        Returns:
        Timeout for running code actions on save.

      • setCodeActionsOnSaveTimeout

        public EditorOptions setCodeActionsOnSaveTimeout​(java.lang.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 java.lang.Number getCodeLensFontSize()
        Returns:
        Code lens font size. Default to 90% of the editor font size.

      • setCodeLensFontSize

        public EditorOptions setCodeLensFontSize​(java.lang.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 java.lang.Number getCursorSurroundingLines()
        Returns:
        Controls the minimal number of visible leading and trailing lines surrounding the cursor. Defaults to 0.

      • setCursorSurroundingLines

        public EditorOptions setCursorSurroundingLines​(java.lang.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 java.lang.Number getCursorWidth()
        Returns:
        Control the width of the cursor when cursorStyle is set to line

      • setCursorWidth

        public EditorOptions setCursorWidth​(java.lang.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 java.lang.Number getFastScrollSensitivity()
        Returns:
        Fast scrolling multiplier speed when pressing Alt Defaults to 5.

      • setFastScrollSensitivity

        public EditorOptions setFastScrollSensitivity​(java.lang.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.

      • getFontSize

        public java.lang.Number getFontSize()
        Returns:
        The font size

      • setFontSize

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

      • isInDiffEditor

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

      • setInDiffEditor

        public EditorOptions setInDiffEditor​(java.lang.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 java.lang.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​(java.lang.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 java.lang.Number getLetterSpacing()
        Returns:
        The letter spacing

      • setLetterSpacing

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

      • getLineHeight

        public java.lang.Number getLineHeight()
        Returns:
        The line height

      • setLineHeight

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

      • getLineNumbersMinChars

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.Number mouseWheelScrollSensitivity)
        Parameters:
        mouseWheelScrollSensitivity - A multiplier to be used on the deltaX and deltaY of mouse wheel scroll events. Defaults to 1.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.

      • getOverviewRulerLanes

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

      • setOverviewRulerLanes

        public EditorOptions setOverviewRulerLanes​(java.lang.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 java.lang.Number getQuickSuggestionsDelay()
        Returns:
        Quick suggestions show delay (in ms) Defaults to 10 (ms)

      • setQuickSuggestionsDelay

        public EditorOptions setQuickSuggestionsDelay​(java.lang.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 java.lang.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​(java.lang.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 java.lang.Number getScrollBeyondLastColumn()
        Returns:
        Enable that scrolling can go beyond the last column by a number of columns. Defaults to 5.

      • setScrollBeyondLastColumn

        public EditorOptions setScrollBeyondLastColumn​(java.lang.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 java.lang.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​(java.lang.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 java.lang.Number getSuggestFontSize()
        Returns:
        The font size for the suggest widget. Defaults to the editor font size.

      • setSuggestFontSize

        public EditorOptions setSuggestFontSize​(java.lang.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 java.lang.Number getSuggestLineHeight()
        Returns:
        The line height for the suggest widget. Defaults to the editor line height.

      • setSuggestLineHeight

        public EditorOptions setSuggestLineHeight​(java.lang.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 java.lang.Number getTabIndex()
        Returns:
        The tabindex property of the editor's textarea.

      • setTabIndex

        public EditorOptions setTabIndex​(java.lang.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 java.lang.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​(java.lang.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 java.lang.String getLineDecorationsWidth()

      • setLineDecorationsWidth

        public EditorOptions setLineDecorationsWidth​(java.lang.Number lineDecorationsWidth)

      • setLineDecorationsWidth

        public EditorOptions setLineDecorationsWidth​(java.lang.String lineDecorationsWidth)

      • getAriaLabel

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

      • setAriaLabel

        public EditorOptions setAriaLabel​(java.lang.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 java.lang.String getCodeLensFontFamily()
        Returns:
        Code lens font family. Defaults to editor font family.

      • setCodeLensFontFamily

        public EditorOptions setCodeLensFontFamily​(java.lang.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 java.lang.String getExtraEditorClassName()
        Returns:
        Class name to be added to the editor.

      • setExtraEditorClassName

        public EditorOptions setExtraEditorClassName​(java.lang.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 java.lang.String getFontFamily()
        Returns:
        The font family

      • setFontFamily

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

      • getWordSeparators

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

      • setWordSeparators

        public EditorOptions setWordSeparators​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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.

      • getSemanticHighlightingEnabled

        public java.lang.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​(java.lang.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.

      • isAutoDetectHighContrast

        public java.lang.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​(java.lang.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.

      • isDetectIndentation

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.Boolean isTrimAutoWhitespace()
        Returns:
        Remove trailing auto inserted whitespace. Defaults to true.

      • setTrimAutoWhitespace

        public EditorOptions setTrimAutoWhitespace​(java.lang.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.

      • isWordBasedSuggestions

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

      • setWordBasedSuggestions

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

      • isWordBasedSuggestionsOnlySameLanguage

        public java.lang.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​(java.lang.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 java.lang.Number getMaxTokenizationLineLength()
        Returns:
        Lines above this length will not be tokenized for performance reasons. Defaults to 20000.

      • setMaxTokenizationLineLength

        public EditorOptions setMaxTokenizationLineLength​(java.lang.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 java.lang.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​(java.lang.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 java.lang.String getAccessibilityHelpUrl()
        Returns:
        An URL to open when Ctrl+H (Windows and Linux) or Cmd+H (OSX) is pressed in the accessibility help dialog in the editor.

      • setAccessibilityHelpUrl

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