Package org.primefaces.extensions.model.monacoeditor

Class EditorSuggestOptions

java.lang.Object
org.primefaces.shaded.json.JSONObject
org.primefaces.extensions.model.monacoeditor.EditorSuggestOptions
All Implemented Interfaces:
Serializable
public class EditorSuggestOptions extends org.primefaces.shaded.json.JSONObject implements Serializable
Configuration options for editor suggest widget
See Also:

  • Constructor Details

    • EditorSuggestOptions

      public EditorSuggestOptions()

  • Method Details

    • isFilterGraceful

      public Boolean isFilterGraceful()
      Returns:
      Enable graceful matching. Defaults to true.

    • setFilterGraceful

      public EditorSuggestOptions setFilterGraceful(Boolean filterGraceful)
      Parameters:
      filterGraceful - Enable graceful matching. Defaults to true.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getInsertMode

      public String getInsertMode()
      Returns:
      Overwrite word ends on accept. Default to false.

    • setInsertMode

      public EditorSuggestOptions setInsertMode(EInsertMode insertMode)
      Parameters:
      insertMode - Overwrite word ends on accept. Default to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setInsertMode

      public EditorSuggestOptions setInsertMode(String insertMode)
      Parameters:
      insertMode - Overwrite word ends on accept. Default to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isLocalityBonus

      public Boolean isLocalityBonus()
      Returns:
      Favours words that appear close to the cursor.

    • setLocalityBonus

      public EditorSuggestOptions setLocalityBonus(Boolean localityBonus)
      Parameters:
      localityBonus - Favours words that appear close to the cursor.
      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 EditorSuggestOptions 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.

    • isPreview

      public Boolean isPreview()
      Returns:
      Enable or disable the rendering of the suggestion preview.

    • setPreview

      public EditorSuggestOptions setPreview(Boolean preview)
      Parameters:
      preview - Enable or disable the rendering of the suggestion preview.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getPreviewMode

      public String getPreviewMode()
      Returns:
      Configures the mode of the preview.

    • setPreviewMode

      public EditorSuggestOptions setPreviewMode(ESuggestPreviewMode previewMode)
      Parameters:
      previewMode - Configures the mode of the preview.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setPreviewMode

      public EditorSuggestOptions setPreviewMode(String previewMode)
      Parameters:
      previewMode - Configures the mode of the preview.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getSelectionMode

      public String getSelectionMode()
      Returns:
      Select suggestions when triggered via quick suggest or trigger characters.

    • setSelectionMode

      public EditorSuggestOptions setSelectionMode(ESuggestSelectionMode selectionMode)
      Parameters:
      selectionMode - Select suggestions when triggered via quick suggest or trigger characters.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setSelectionMode

      public EditorSuggestOptions setSelectionMode(String selectionMode)
      Parameters:
      selectionMode - Select suggestions when triggered via quick suggest or trigger characters.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShareSuggestSelections

      public Boolean isShareSuggestSelections()
      Returns:
      Enable using global storage for remembering suggestions.

    • setShareSuggestSelections

      public EditorSuggestOptions setShareSuggestSelections(Boolean shareSuggestSelections)
      Parameters:
      shareSuggestSelections - Enable using global storage for remembering suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowClasses

      public Boolean isShowClasses()
      Returns:
      Show class-suggestions.

    • setShowClasses

      public EditorSuggestOptions setShowClasses(Boolean showClasses)
      Parameters:
      showClasses - Show class-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowColors

      public Boolean isShowColors()
      Returns:
      Show color-suggestions.

    • setShowColors

      public EditorSuggestOptions setShowColors(Boolean showColors)
      Parameters:
      showColors - Show color-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowConstants

      public Boolean isShowConstants()
      Returns:
      Show constant-suggestions.

    • setShowConstants

      public EditorSuggestOptions setShowConstants(Boolean showConstants)
      Parameters:
      showConstants - Show constant-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowConstructors

      public Boolean isShowConstructors()
      Returns:
      Show constructor-suggestions.

    • setShowConstructors

      public EditorSuggestOptions setShowConstructors(Boolean showConstructors)
      Parameters:
      showConstructors - Show constructor-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowDeprecated

      public Boolean isShowDeprecated()
      Returns:
      Show deprecated-suggestions.

    • setShowDeprecated

      public EditorSuggestOptions setShowDeprecated(Boolean showDeprecated)
      Parameters:
      showDeprecated - Show deprecated-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowEnumMembers

      public Boolean isShowEnumMembers()
      Returns:
      Show enumMember-suggestions.

    • setShowEnumMembers

      public EditorSuggestOptions setShowEnumMembers(Boolean showEnumMembers)
      Parameters:
      showEnumMembers - Show enumMember-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowEnums

      public Boolean isShowEnums()
      Returns:
      Show enum-suggestions.

    • setShowEnums

      public EditorSuggestOptions setShowEnums(Boolean showEnums)
      Parameters:
      showEnums - Show enum-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowEvents

      public Boolean isShowEvents()
      Returns:
      Show event-suggestions.

    • setShowEvents

      public EditorSuggestOptions setShowEvents(Boolean showEvents)
      Parameters:
      showEvents - Show event-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowFields

      public Boolean isShowFields()
      Returns:
      Show field-suggestions.

    • setShowFields

      public EditorSuggestOptions setShowFields(Boolean showFields)
      Parameters:
      showFields - Show field-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowFiles

      public Boolean isShowFiles()
      Returns:
      Show file-suggestions.

    • setShowFiles

      public EditorSuggestOptions setShowFiles(Boolean showFiles)
      Parameters:
      showFiles - Show file-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowFolders

      public Boolean isShowFolders()
      Returns:
      Show folder-suggestions.

    • setShowFolders

      public EditorSuggestOptions setShowFolders(Boolean showFolders)
      Parameters:
      showFolders - Show folder-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowFunctions

      public Boolean isShowFunctions()
      Returns:
      Show function-suggestions.

    • setShowFunctions

      public EditorSuggestOptions setShowFunctions(Boolean showFunctions)
      Parameters:
      showFunctions - Show function-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowIcons

      public Boolean isShowIcons()
      Returns:
      Enable or disable icons in suggestions. Defaults to true.

    • setShowIcons

      public EditorSuggestOptions setShowIcons(Boolean showIcons)
      Parameters:
      showIcons - Enable or disable icons in suggestions. Defaults to true.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowInlineDetails

      public Boolean isShowInlineDetails()
      Returns:
      Show details inline with the label. Defaults to true.

    • setShowInlineDetails

      public EditorSuggestOptions setShowInlineDetails(Boolean showInlineDetails)
      Parameters:
      showInlineDetails - Show details inline with the label. Defaults to true.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowInterfaces

      public Boolean isShowInterfaces()
      Returns:
      Show interface-suggestions.

    • setShowInterfaces

      public EditorSuggestOptions setShowInterfaces(Boolean showInterfaces)
      Parameters:
      showInterfaces - Show interface-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowIssues

      public Boolean isShowIssues()
      Returns:
      Show issue-suggestions.

    • setShowIssues

      public EditorSuggestOptions setShowIssues(Boolean showIssues)
      Parameters:
      showIssues - Show issue-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowKeywords

      public Boolean isShowKeywords()
      Returns:
      Show keyword-suggestions.

    • setShowKeywords

      public EditorSuggestOptions setShowKeywords(Boolean showKeywords)
      Parameters:
      showKeywords - Show keyword-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowMethods

      public Boolean isShowMethods()
      Returns:
      Show method-suggestions.

    • setShowMethods

      public EditorSuggestOptions setShowMethods(Boolean showMethods)
      Parameters:
      showMethods - Show method-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowModules

      public Boolean isShowModules()
      Returns:
      Show module-suggestions.

    • setShowModules

      public EditorSuggestOptions setShowModules(Boolean showModules)
      Parameters:
      showModules - Show module-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowOperators

      public Boolean isShowOperators()
      Returns:
      Show operator-suggestions.

    • setShowOperators

      public EditorSuggestOptions setShowOperators(Boolean showOperators)
      Parameters:
      showOperators - Show operator-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowProperties

      public Boolean isShowProperties()
      Returns:
      Show property-suggestions.

    • setShowProperties

      public EditorSuggestOptions setShowProperties(Boolean showProperties)
      Parameters:
      showProperties - Show property-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowReferences

      public Boolean isShowReferences()
      Returns:
      Show reference-suggestions.

    • setShowReferences

      public EditorSuggestOptions setShowReferences(Boolean showReferences)
      Parameters:
      showReferences - Show reference-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowSnippets

      public Boolean isShowSnippets()
      Returns:
      Show snippet-suggestions.

    • setShowSnippets

      public EditorSuggestOptions setShowSnippets(Boolean showSnippets)
      Parameters:
      showSnippets - Show snippet-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowStatusBar

      public Boolean isShowStatusBar()
      Returns:
      Enable or disable the suggest status bar.

    • setShowStatusBar

      public EditorSuggestOptions setShowStatusBar(Boolean showStatusBar)
      Parameters:
      showStatusBar - Enable or disable the suggest status bar.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowStructs

      public Boolean isShowStructs()
      Returns:
      Show struct-suggestions.

    • setShowStructs

      public EditorSuggestOptions setShowStructs(Boolean showStructs)
      Parameters:
      showStructs - Show struct-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowTypeParameters

      public Boolean isShowTypeParameters()
      Returns:
      Show typeParameter-suggestions.

    • setShowTypeParameters

      public EditorSuggestOptions setShowTypeParameters(Boolean showTypeParameters)
      Parameters:
      showTypeParameters - Show typeParameter-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowUnits

      public Boolean isShowUnits()
      Returns:
      Show unit-suggestions.

    • setShowUnits

      public EditorSuggestOptions setShowUnits(Boolean showUnits)
      Parameters:
      showUnits - Show unit-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowUsers

      public Boolean isShowUsers()
      Returns:
      Show user-suggestions.

    • setShowUsers

      public EditorSuggestOptions setShowUsers(Boolean showUsers)
      Parameters:
      showUsers - Show user-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowValues

      public Boolean isShowValues()
      Returns:
      Show value-suggestions.

    • setShowValues

      public EditorSuggestOptions setShowValues(Boolean showValues)
      Parameters:
      showValues - Show value-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowVariables

      public Boolean isShowVariables()
      Returns:
      Show variable-suggestions.

    • setShowVariables

      public EditorSuggestOptions setShowVariables(Boolean showVariables)
      Parameters:
      showVariables - Show variable-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowWords

      public Boolean isShowWords()
      Returns:
      Show text-suggestions.

    • setShowWords

      public EditorSuggestOptions setShowWords(Boolean showWords)
      Parameters:
      showWords - Show text-suggestions.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isSnippetsPreventQuickSuggestions

      public Boolean isSnippetsPreventQuickSuggestions()
      Returns:
      Prevent quick suggestions when a snippet is active. Defaults to true.

    • setSnippetsPreventQuickSuggestions

      public EditorSuggestOptions setSnippetsPreventQuickSuggestions(Boolean snippetsPreventQuickSuggestions)
      Parameters:
      snippetsPreventQuickSuggestions - Prevent quick suggestions when a snippet is active. Defaults to true.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.