Class EditorUnicodeHighlightOptions

  • All Implemented Interfaces:
    java.io.Serializable

    public class EditorUnicodeHighlightOptions
    extends org.primefaces.shaded.json.JSONObject
    implements java.io.Serializable
    Controls the behavior of the unicode highlight feature (by default, ambiguous and invisible characters are highlighted).
    See Also:
    Serialized Form
    • Constructor Detail

      • EditorUnicodeHighlightOptions

        public EditorUnicodeHighlightOptions()
    • Method Detail

      • getAllowedCharacters

        public org.primefaces.shaded.json.JSONObject getAllowedCharacters()
        Returns:
        A map of allowed characters (true: allowed).
      • setAllowedCharacters

        public EditorUnicodeHighlightOptions setAllowedCharacters​(org.primefaces.shaded.json.JSONObject allowedCharacters)
        Parameters:
        allowedCharacters - A map of allowed characters (true: allowed).
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • addAllowedCharacter

        public EditorUnicodeHighlightOptions addAllowedCharacter​(java.lang.String key,
                                                                 java.lang.Boolean value)
        A map of allowed characters (true: allowed).
        Parameters:
        key - The key of the map entry to add.
        value - The value to associate with the key.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • setAllowedCharacters

        public EditorUnicodeHighlightOptions setAllowedCharacters​(java.util.Map<java.lang.String,​java.lang.Boolean> allowedCharacters)
        Parameters:
        allowedCharacters - A map of allowed characters (true: allowed).
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • getAllowedLocales

        public org.primefaces.shaded.json.JSONObject getAllowedLocales()
        Returns:
        Unicode characters that are common in allowed locales are not being highlighted. (true: allowed).
      • setAllowedLocales

        public EditorUnicodeHighlightOptions setAllowedLocales​(org.primefaces.shaded.json.JSONObject allowedLocales)
        Parameters:
        allowedLocales - Unicode characters that are common in allowed locales are not being highlighted. ( true: allowed).
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • addAllowedLocale

        public EditorUnicodeHighlightOptions addAllowedLocale​(java.lang.String key,
                                                              java.lang.Boolean value)
        Unicode characters that are common in allowed locales are not being highlighted. (true: allowed).
        Parameters:
        key - The key of the map entry to add.
        value - The value to associate with the key.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • setAllowedLocales

        public EditorUnicodeHighlightOptions setAllowedLocales​(java.util.Map<java.lang.String,​java.lang.Boolean> allowedLocales)
        Parameters:
        allowedLocales - Unicode characters that are common in allowed locales are not being highlighted. ( true: allowed).
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • isAmbiguousCharacters

        public java.lang.Boolean isAmbiguousCharacters()
        Returns:
        Controls whether characters are highlighted that can be confused with basic ASCII characters, except those that are common in the current user locale.
      • setAmbiguousCharacters

        public EditorUnicodeHighlightOptions setAmbiguousCharacters​(java.lang.Boolean ambiguousCharacters)
        Parameters:
        ambiguousCharacters - Controls whether characters are highlighted that can be confused with basic ASCII characters, except those that are common in the current user locale.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • isIncludeComments

        public java.lang.Boolean isIncludeComments()
      • getIncludeComments

        public java.lang.String getIncludeComments()
      • isIncludeStrings

        public java.lang.Boolean isIncludeStrings()
      • getIncludeStrings

        public java.lang.String getIncludeStrings()
      • isInvisibleCharacters

        public java.lang.Boolean isInvisibleCharacters()
        Returns:
        Controls whether characters that just reserve space or have no width at all are highlighted.
      • setInvisibleCharacters

        public EditorUnicodeHighlightOptions setInvisibleCharacters​(java.lang.Boolean invisibleCharacters)
        Parameters:
        invisibleCharacters - Controls whether characters that just reserve space or have no width at all are highlighted.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • isNonBasicASCII

        public java.lang.Boolean isNonBasicASCII()
      • getNonBasicASCII

        public java.lang.String getNonBasicASCII()