Class EditorSuggestOptions

  • All Implemented Interfaces:
    java.io.Serializable

    public class EditorSuggestOptions
    extends org.primefaces.shaded.json.JSONObject
    implements java.io.Serializable
    See Also:
    Serialized Form
    • Constructor Detail

      • EditorSuggestOptions

        public EditorSuggestOptions()
    • Method Detail

      • isFilterGraceful

        public java.lang.Boolean isFilterGraceful()
        Returns:
        Enable graceful matching. Defaults to true.
      • setFilterGraceful

        public EditorSuggestOptions setFilterGraceful​(java.lang.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 java.lang.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.
      • isLocalityBonus

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

        public EditorSuggestOptions setLocalityBonus​(java.lang.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.
      • isMaxVisibleSuggestions

        public java.lang.Boolean isMaxVisibleSuggestions()
        Returns:
        Max suggestions to show in suggestions. Defaults to 12.
      • setMaxVisibleSuggestions

        public EditorSuggestOptions setMaxVisibleSuggestions​(java.lang.Boolean maxVisibleSuggestions)
        Parameters:
        maxVisibleSuggestions - Max suggestions to show in suggestions. Defaults to 12.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • isShareSuggestSelections

        public java.lang.Boolean isShareSuggestSelections()
        Returns:
        Enable using global storage for remembering suggestions.
      • setShareSuggestSelections

        public EditorSuggestOptions setShareSuggestSelections​(java.lang.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 java.lang.Boolean isShowClasses()
        Returns:
        Show class-suggestions.
      • setShowClasses

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

        public java.lang.Boolean isShowColors()
        Returns:
        Show color-suggestions.
      • setShowColors

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

        public java.lang.Boolean isShowConstants()
        Returns:
        Show constant-suggestions.
      • setShowConstants

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

        public java.lang.Boolean isShowConstructors()
        Returns:
        Show constructor-suggestions.
      • setShowConstructors

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

        public java.lang.Boolean isShowEnumMembers()
        Returns:
        Show enumMember-suggestions.
      • setShowEnumMembers

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

        public java.lang.Boolean isShowEnums()
        Returns:
        Show enum-suggestions.
      • setShowEnums

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

        public java.lang.Boolean isShowEvents()
        Returns:
        Show event-suggestions.
      • setShowEvents

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

        public java.lang.Boolean isShowFields()
        Returns:
        Show field-suggestions.
      • setShowFields

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

        public java.lang.Boolean isShowFiles()
        Returns:
        Show file-suggestions.
      • setShowFiles

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

        public java.lang.Boolean isShowFolders()
        Returns:
        Show folder-suggestions.
      • setShowFolders

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

        public java.lang.Boolean isShowFunctions()
        Returns:
        Show function-suggestions.
      • setShowFunctions

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

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

        public EditorSuggestOptions setShowIcons​(java.lang.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.
      • isShowInterfaces

        public java.lang.Boolean isShowInterfaces()
        Returns:
        Show interface-suggestions.
      • setShowInterfaces

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

        public java.lang.Boolean isShowIssues()
        Returns:
        Show issue-suggestions.
      • setShowIssues

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

        public java.lang.Boolean isShowKeywords()
        Returns:
        Show keyword-suggestions.
      • setShowKeywords

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

        public java.lang.Boolean isShowMethods()
        Returns:
        Show method-suggestions.
      • setShowMethods

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

        public java.lang.Boolean isShowModules()
        Returns:
        Show module-suggestions.
      • setShowModules

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

        public java.lang.Boolean isShowOperators()
        Returns:
        Show operator-suggestions.
      • setShowOperators

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

        public java.lang.Boolean isShowProperties()
        Returns:
        Show property-suggestions.
      • setShowProperties

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

        public java.lang.Boolean isShowReferences()
        Returns:
        Show reference-suggestions.
      • setShowReferences

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

        public java.lang.Boolean isShowSnippets()
        Returns:
        Show snippet-suggestions.
      • setShowSnippets

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

        public java.lang.Boolean isShowStructs()
        Returns:
        Show struct-suggestions.
      • setShowStructs

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

        public java.lang.Boolean isShowTypeParameters()
        Returns:
        Show typeParameter-suggestions.
      • setShowTypeParameters

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

        public java.lang.Boolean isShowUnits()
        Returns:
        Show unit-suggestions.
      • setShowUnits

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

        public java.lang.Boolean isShowUsers()
        Returns:
        Show user-suggestions.
      • setShowUsers

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

        public java.lang.Boolean isShowValues()
        Returns:
        Show value-suggestions.
      • setShowValues

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

        public java.lang.Boolean isShowVariables()
        Returns:
        Show variable-suggestions.
      • setShowVariables

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

        public java.lang.Boolean isShowWords()
        Returns:
        Show text-suggestions.
      • setShowWords

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

        public java.lang.Boolean isInsertHighlight()
        Returns:
        Show a highlight when suggestion replaces or keep text after the cursor. Defaults to false.
      • setInsertHighlight

        public EditorSuggestOptions setInsertHighlight​(java.lang.Boolean insertHighlight)
        Parameters:
        insertHighlight - Show a highlight when suggestion replaces or keep text after the cursor. Defaults to false.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • isSnippetsPreventQuickSuggestions

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

        public EditorSuggestOptions setSnippetsPreventQuickSuggestions​(java.lang.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.
      • setStatusBar

        public EditorSuggestOptions setStatusBar​(SuggestOptionsStatusBar statusBar)
        Parameters:
        statusBar - Status bar related settings.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.