Package org.eclipse.search.ui.text
Class MatchFilter
java.lang.Object
org.eclipse.search.ui.text.MatchFilter
A match filter is used to evaluate the filter state of a match (
Match.isFiltered(). Filters are
managed by the (AbstractTextSearchResult.- Since:
- 3.3
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract booleanReturns whether the given match is filtered by this filter.abstract StringReturns the label of the filter as shown by the filter action.abstract StringReturns the description of the filter as shown in the match filter selection dialog.abstract StringgetID()Returns an ID of this filter.abstract StringgetName()Returns the name of the filter as shown in the match filter selection dialog.
-
Constructor Details
-
MatchFilter
public MatchFilter()
-
-
Method Details
-
filters
Returns whether the given match is filtered by this filter.- Parameters:
match- the match to look at- Returns:
- returns
trueif the given match should be filtered orfalseif not.
-
getName
Returns the name of the filter as shown in the match filter selection dialog.- Returns:
- the name of the filter as shown in the match filter selection dialog.
-
getDescription
Returns the description of the filter as shown in the match filter selection dialog.- Returns:
- the description of the filter as shown in the match filter selection dialog.
-
getActionLabel
Returns the label of the filter as shown by the filter action.- Returns:
- the label of the filter as shown by the filter action.
-
getID
Returns an ID of this filter.- Returns:
- the id of the filter to be used when persisting this filter.
-