Eclipse Platform
Release 3.3

org.eclipse.search.ui.text
Class FilterUpdateEvent

java.lang.Object
  extended byjava.util.EventObject
      extended byorg.eclipse.search.ui.SearchResultEvent
          extended byorg.eclipse.search.ui.text.FilterUpdateEvent
All Implemented Interfaces:
Serializable

public class FilterUpdateEvent
extends SearchResultEvent

An event object describing that the filter state of the given matches has been updated or match filters have been reconfigured.

Clients may instantiate or subclass this class.

Since:
3.3
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
FilterUpdateEvent(ISearchResult searchResult, Match[] matches, MatchFilter[] filters)
          Constructs a new FilterUpdateEvent.
 
Method Summary
 MatchFilter[] getActiveFilters()
          Returns the the filters currently set, or null if filters have been disabled.
 Match[] getUpdatedMatches()
          Returns the matches updated by the filter update.
 
Methods inherited from class org.eclipse.search.ui.SearchResultEvent
getSearchResult
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FilterUpdateEvent

public FilterUpdateEvent(ISearchResult searchResult,
                         Match[] matches,
                         MatchFilter[] filters)
Constructs a new FilterUpdateEvent.

Parameters:
searchResult - the search result concerned
matches - the matches updated by the filter change
filters - the currently activated filters
Method Detail

getUpdatedMatches

public Match[] getUpdatedMatches()
Returns the matches updated by the filter update.

Returns:
the matches updated by the filter update

getActiveFilters

public MatchFilter[] getActiveFilters()
Returns the the filters currently set, or null if filters have been disabled.

Returns:
the filters currently set

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.