Package docking.widgets.fieldpanel.support

# Interface FieldHighlightFactory

All Known Implementing Classes:
  `ListingFieldHighlightFactoryAdapter`

public interface FieldHighlightFactory
A highlighter for for `Field`s.

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final Highlight[]`
  `NO_HIGHLIGHTS`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Highlight[]`
  `createHighlights(Field field, String text, int cursorTextOffset)`
  Returns the highlights for the given text

- ## Field Details

  - ### NO_HIGHLIGHTS

    static final Highlight[] NO_HIGHLIGHTS

- ## Method Details

  - ### createHighlights

    Highlight[] createHighlights(Field field, String text, int cursorTextOffset)
    Returns the highlights for the given text
    Parameters:
      `field` - the field that is requesting the highlight
      `text` - the text to be considered for highlighting
      `cursorTextOffset` - the position in the given text of the cursor. A -1 indicates the cursor is not in this field.
    Returns:
      an array of highlights to be rendered