Interface HighlightProvider

All Known Implementing Classes:
ListingDiffHighlightProvider

public interface HighlightProvider
Provider of Highlight objects appropriate for the text, object, and FieldFactory class.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Highlight[]
     
  • Method Summary

    Modifier and Type
    Method
    Description
    getHighlights(String text, Object obj, Class<? extends FieldFactory> fieldFactoryClass, int cursorTextOffset)
    Get the highlights appropriate for the given text, object, and FieldFactory class.
  • Field Details

    • EMPTY_HIGHLIGHT

      static final Highlight[] EMPTY_HIGHLIGHT
  • Method Details

    • getHighlights

      Highlight[] getHighlights(String text, Object obj, Class<? extends FieldFactory> fieldFactoryClass, int cursorTextOffset)
      Get the highlights appropriate for the given text, object, and FieldFactory class.
      Parameters:
      text - the entire text contained in the field, regardless of layout.
      obj - object that provides the information to be rendered (usually a code unit)
      fieldFactoryClass - the class that indicates what type of field is being rendered. For Example, address fields would have the AddressFieldFactory class.
      cursorTextOffset - the cursor position within the given text or -1 if no cursor in this field.
      Returns:
      an array of highlight objects that indicate the location within the text string to be highlighted.