oracle.javatools.ui.search

Class SearchEvent

java.lang.Object

java.util.EventObject

oracle.javatools.ui.search.SearchEvent

All Implemented Interfaces:

java.io.Serializable

public final class SearchEvent
extends java.util.EventObject

An event fired by the SearchField.

Since:

11.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchEvent.Direction

Field Summary

Fields inherited from class java.util.EventObject

source

Method Summary

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 SearchFields 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()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

isTriggeredByKeypress

public boolean isTriggeredByKeypress()

Returns true if the event was triggered by a keypress rather than an explicit user action.

Returns:

true if the event was triggered by a keypress.

isFromClear

public boolean isFromClear()

Returns true if the event was triggered by a clearing of the search field by clicking in the clear search button.

Returns:

true if the event was triggered by a clear button press.

getSearchText

public java.lang.String getSearchText()

Returns the text to search for.

Returns:

text to search for. May be an empty string, in which case, the current search should be cleared. Does not return null.

getSearchCategory

public SearchCategory getSearchCategory()

Returns the category to search in.

Returns:

the category to search in. May be null if no category is available or selected.

getSearchProgress

public SearchProgress getSearchProgress()

Returns an instance of SearchProgress that you can use for searches on SearchFields with style SearchField.Style.SEARCH to notify the field of search progress.

This method should only be called on searchPerformed events received from SearchFields of style SearchField.Style.SEARCH.

Returns:

the search progress notifier.

Throws:

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.

getDirection

public SearchEvent.Direction getDirection()

Returns the direction of the search. For search fields of type FIND, this returns FORWARD or BACKWARD depending on the search direction requested. For other types of search, it always returns FORWARD.

Returns:

the direction of the search.

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject