Interface ISearchResultViewEntry


  • @Deprecated
    public interface ISearchResultViewEntry
    Deprecated.
    Part of the old ('classic') search result view. Since 3.0 clients can create their own search result view pages (see ISearchResultPage), leaving it up to the search how to model search results. AbstractTextSearchResult and Match can be used to port old searches to the new API design.
    Specifies a search result view entry. This entry provides information about the markers it groups by a client defined key. Each entry in the search result view corresponds to a different key.

    The UI allows stepping through this entry's markers grouped by the key.

    This interface is not intended to be implemented by clients.

    Restriction:
    This interface is not intended to be implemented by clients.
    Restriction:
    This interface is not intended to be extended by clients.
    • Method Detail

      • getResource

        IResource getResource()
        Deprecated.
        Returns the resource to which this entry's markers are attached. This is a convenience method for getSelectedMarker().getResource().
        Returns:
        the common resource of this entry's markers
      • getMatchCount

        int getMatchCount()
        Deprecated.
        Returns the number of markers grouped by this entry.
        Returns:
        the number of markers
      • getSelectedMarker

        IMarker getSelectedMarker()
        Deprecated.
        Returns the selected marker of this entry, or the first one if no marker is selected. A search results view entry can group markers which the UI allows the user to step through them while this entry remains selected.
        Returns:
        the selected marker inside this entry, or null if the entry has no markers