javax.help.search
Class SearchEvent
java.util.EventObject
javax.help.search.SearchEvent
public class SearchEvent
extends java.util.EventObject
Encapsulates information that describes changes to a SearchQuery. It is used
to notify listeners of the change.
SearchEvent(Object source, String params, boolean searching) - Represents a change in the SearchEngine.
|
SearchEvent(Object source, String params, boolean searching, Vector items) - Represents a change in the SearchEngine.
|
String | getParams() - Returns the parameters to the query.
|
Enumeration | getSearchItems() - An enumerated list of SearchItems that match parameters of the query.
|
boolean | isSearchCompleted() - A boolean value that indicates if the search is completed.
|
SearchEvent
public SearchEvent(Object source,
String params,
boolean searching)
Represents a change in the SearchEngine. Used for starting the search
or ending the search.
source
- The source of this event.params
- The search parameters.searching
- A boolean operator that indicates if searching is
executing (true) or stopped (false).
SearchEvent
public SearchEvent(Object source,
String params,
boolean searching,
Vector items)
Represents a change in the SearchEngine. Used to indicate that either a single
item or a group of items have matched the params.
source
- The source of this event.params
- The search parameters.searching
- A boolean operator that indicates if a search is
executing (true) or stopped (false).items
- A Vector of SearchItems matching the the search params.
java.javahelp.SearchItems
getParams
public String getParams()
Returns the parameters to the query.
getSearchItems
public Enumeration getSearchItems()
An enumerated list of SearchItems that match parameters of the query.
isSearchCompleted
public boolean isSearchCompleted()
A boolean value that indicates if the search is completed.