Module is.codion.swing.common.ui
Package is.codion.swing.common.ui.component.text

Interface SearchHighlighter.Builder

Enclosing class:
SearchHighlighter
public static interface SearchHighlighter.Builder
Builds a SearchHighlighter.

  • Method Details

    • highlightColor

      SearchHighlighter.Builder highlightColor(Color highlightColor)
      Parameters:
      highlightColor - the highlight color
      Returns:
      this builder

    • selectedHighlightColor

      SearchHighlighter.Builder selectedHighlightColor(Color selectedHighlightColor)
      Parameters:
      selectedHighlightColor - the selected highlight color
      Returns:
      this builder

    • caseSensitive

      SearchHighlighter.Builder caseSensitive(boolean caseSensitive)
      Parameters:
      caseSensitive - true if the search should be case-sensitive, default tue
      Returns:
      this builder

    • scrollYRatio

      SearchHighlighter.Builder scrollYRatio(double scrollYRatio)
      Parameters:
      scrollYRatio - specifies the Y axis scroll ratio when scrolling to a search result, 0 being at the top and 1 at the bottom, default 0.5
      Returns:
      this builder
      Throws:
      IllegalArgumentException - in case the value is not between 0 and 1

    • scrollXRatio

      SearchHighlighter.Builder scrollXRatio(double scrollXRatio)
      Parameters:
      scrollXRatio - specifies the X axis scroll ratio when scrolling to a search result, 0 being all the way to the left and 1 all the way to the right, default 0.5
      Returns:
      this builder
      Throws:
      IllegalArgumentException - in case the value is not between 0 and 1

    • build

      SearchHighlighter build()
      Returns:
      a new SearchHighlighter