Interface HighlightData

  • All Superinterfaces:
    Chunk, java.io.Serializable

    public interface HighlightData
    extends Chunk
    This is a container to display certain highlights in the pages displayed in a GUI component.
    • Method Detail

      • getPageHighlights

        java.util.List<HighlightData.Highlight> getPageHighlights​(int pageNr,
                                                                  boolean firstDocument)
        Returns the highlights of this container for a certain page
        Parameters:
        pageNr - the page number, zero-based
        firstDocument - true if the first document is referenced, false for the second one
        Returns:
        the highlights for this page, may be null if there are none
        Since:
        3.0
      • getFilterKey

        java.lang.String getFilterKey()
        Returns the key of the filter which created the highlight. This key is the same as ISortFilter.getExtensionName() of the source filter.
        Returns:
        the highlight type key, may be null for highlights that are only used internally.
        Since:
        4.0