Package org.eclipse.search.ui.text
Interface IEditorMatchAdapter
-
public interface IEditorMatchAdapter
This interface serves as an adapter between matches and editors. It is used to highlight matches in editors. Search implementors who want their matches highlighted must return an implementation ofIEditorMatchAdapter
from thegetEditorMatchAdapter()
method in their search result subclass. It is assumed that the match adapters are stateless, and no lifecycle management is provided.Clients may implement this interface.
- Since:
- 3.0
- See Also:
AbstractTextSearchResult
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Match[]
computeContainedMatches(AbstractTextSearchResult result, IEditorPart editor)
Returns all matches that are contained in the element shown in the given editor.boolean
isShownInEditor(Match match, IEditorPart editor)
Determines whether a match should be displayed in the given editor.
-
-
-
Method Detail
-
isShownInEditor
boolean isShownInEditor(Match match, IEditorPart editor)
Determines whether a match should be displayed in the given editor. For example, if a match is reported in a file, This method should returntrue
, if the given editor displays the file.- Parameters:
match
- The matcheditor
- The editor that possibly contains the matches element- Returns:
- whether the given match should be displayed in the editor
-
computeContainedMatches
Match[] computeContainedMatches(AbstractTextSearchResult result, IEditorPart editor)
Returns all matches that are contained in the element shown in the given editor. For example, if the editor shows a particular file, all matches in that file should be returned.- Parameters:
result
- the result to search for matcheseditor
- The editor.- Returns:
- All matches that are contained in the element that is shown in the given editor.
-
-