public final class SearchEvent
extends java.util.EventObject
SearchField
.Modifier and Type | Class and Description |
---|---|
static class |
SearchEvent.Direction |
Modifier and Type | Method and Description |
---|---|
SearchEvent.Direction |
getDirection()
Returns the direction of the search.
|
SearchCategory |
getSearchCategory()
Returns the category to search in.
|
SearchProgress |
getSearchProgress()
Returns an instance of
SearchProgress that you can use for
searches on SearchField s with style SearchField.Style.SEARCH
to notify the field of search progress. |
java.lang.String |
getSearchText()
Returns the text to search for.
|
boolean |
isFromClear()
Returns true if the event was triggered by a clearing of the
search field by clicking in the clear search button.
|
boolean |
isTriggeredByKeypress()
Returns true if the event was triggered by a keypress rather than
an explicit user action.
|
java.lang.String |
toString() |
public boolean isTriggeredByKeypress()
public boolean isFromClear()
public java.lang.String getSearchText()
public SearchCategory getSearchCategory()
public SearchProgress getSearchProgress()
SearchProgress
that you can use for
searches on SearchField
s with style SearchField.Style.SEARCH
to notify the field of search progress.
This method should only be called on searchPerformed
events received from
SearchField
s of style
SearchField.Style.SEARCH
.
java.lang.IllegalStateException
- if the SearchField
that fired this
event is not of style
SearchField.Style.SEARCH
, or the event object does not belong
to a searchPerformed
event.public SearchEvent.Direction getDirection()
public java.lang.String toString()
toString
in class java.util.EventObject