org.eclipse.jdt.ui.search
Interface IMatchPresentation
-
public interface IMatchPresentation
This interface serves to display elements that a search participant has contributed to a search
result.
Each
IMatchPresentation is associated with a particular
IQueryParticipant. The
IMatchPresentation
will only be asked to handle elements and matches which its
IQueryParticipant contributed to the
search result. If two search participants report matches against the same element, one of them will
be chosen to handle the element.
Clients may implement this interface.
-
Since:
- 3.0
|
Method Summary
|
ILabelProvider
|
createLabelProvider
()
Creates a new instance of a label provider for elements that have been contributed
to a search result by the corresponding query participant. |
void
|
showMatch
(
Match match,
int currentOffset,
int currentLength,
boolean activate)
Opens an editor on the given element and selects the given range of text. |
createLabelProvider
ILabelProvider createLabelProvider()
- Creates a new instance of a label provider for elements that have been contributed
to a search result by the corresponding query participant. The search view
will call this method when it needs to render elements and will dispose the
label providers when it is done with them. This method may therefore be called
multiple times.
-
-
Returns:
- A label provider for elements found by the corresponding query participant.
showMatch
void showMatch(
Match match,
int currentOffset,
int currentLength,
boolean activate)
throws
PartInitException
- Opens an editor on the given element and selects the given range of text.
The location of matches are automatically updated when a file is edited
through the file buffer infrastructure (see
ITextFileBufferManager).
When a file buffer is saved, the current positions are written back to the
match.
If the activate parameter is true the opened editor
should have be activated. Otherwise the focus should not be changed.
-
-
Parameters:
-
match - The match to show. -
currentOffset - The current start offset of the match. -
currentLength - The current length of the selection. -
activate - Whether to activate the editor the match is shown in.
-
Throws:
-
PartInitException
- If an editor can't be opened.
Copyright (c) IBM Corp. and others 2000, 2008. All Rights Reserved.
