Class WSuggestionPopup.Options

  • Enclosing class:
    WSuggestionPopup

    public static class WSuggestionPopup.Options
    extends java.lang.Object
    A configuration object to generate a matcher and replacer JavaScript function.

    See Also:
    WSuggestionPopup
    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String appendReplacedText
      When replacing the current edited value with suggestion value, append the following string as well.
      java.lang.String highlightBeginTag
      Open tag to highlight a match in a suggestion.
      java.lang.String highlightEndTag
      Close tag to highlight a match in a suggestion.
      char listSeparator
      When editing a list of values, the separator used for different items.
      java.lang.String whitespace
      When editing a value, the whitespace characters ignored before the current value.
      java.lang.String wordSeparators
      Characters that start a word in a suggestion to match against.
      java.lang.String wordStartRegexp
      Regular expression that starts a word in a suggestion to match against.
    • Constructor Summary

      Constructors 
      Constructor Description
      Options()
      Constructor.
    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • highlightBeginTag

        public java.lang.String highlightBeginTag
        Open tag to highlight a match in a suggestion.

        Must be an opening markup tag, such as <b>.

        Used during matching.

      • highlightEndTag

        public java.lang.String highlightEndTag
        Close tag to highlight a match in a suggestion.

        Must be a closing markup tag, such as </b>.

        Used during matching.

      • listSeparator

        public char listSeparator
        When editing a list of values, the separator used for different items.

        For example, ',' to separate different values on comma. Specify 0 ('\0') for no list separation.

        Used during matching and replacing.

      • whitespace

        public java.lang.String whitespace
        When editing a value, the whitespace characters ignored before the current value.

        For example, " \n" to ignore spaces and newlines.

        Used during matching and replacing.

      • wordSeparators

        public java.lang.String wordSeparators
        Characters that start a word in a suggestion to match against.

        For example, " .@" will also match with suggestion text after a space, a dot (.) or an at-symbol (@). Alternatively you may also specify this as a regular expression in wordStartRegexp.

        Used during matching.

      • appendReplacedText

        public java.lang.String appendReplacedText
        When replacing the current edited value with suggestion value, append the following string as well.

        Used during replacing.

      • wordStartRegexp

        public java.lang.String wordStartRegexp
        Regular expression that starts a word in a suggestion to match against.

        When empty, the value of wordSeparators is used instead.

        Used during replacing.

    • Constructor Detail

      • Options

        public Options()
        Constructor.