Package com.jidesoft.swing.event
Class SearchableEvent
java.lang.Object
java.util.EventObject
java.awt.AWTEvent
com.jidesoft.swing.event.SearchableEvent
- All Implemented Interfaces:
Serializable
An
AWTEvent
that adds support for
SearchableEvent
objects as the event source.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
To indicate the searching text changes.static final int
To indicate the searching process stopped.static final int
The first number in the range of IDs used forSearchableEvent
.static final int
The last number in the range of IDs used forSearchableEvent
.static final int
To indicate the searching process finds a matching element.static final int
To indicate the search component model is changed.static final int
To indicate the searching process doesn't find a matching element.static final int
To indicate the searching process started.Fields inherited from class java.awt.AWTEvent
ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK
Fields inherited from class java.util.EventObject
source
-
Constructor Summary
ConstructorsConstructorDescriptionSearchableEvent
(Searchable source, int id) Creates aSearchableEvent
.SearchableEvent
(Object source, int id, String searchingText) Creates aSearchableEvent
.SearchableEvent
(Object source, int id, String searchingText, Object matchingObject, String matchingText) SearchableEvent
(Object source, int id, String searchingText, String oldSearchingText) -
Method Summary
Modifier and TypeMethodDescriptionGets the object that matches the searching text.Gets the text that is converted from the object matching the searching text.Gets the text that was searched for.Returns the originator of the event.Gets the text that is being searched for.Returns a parameter string identifying this event.Methods inherited from class java.util.EventObject
getSource
-
Field Details
-
SEARCHABLE_FIRST
public static final int SEARCHABLE_FIRSTThe first number in the range of IDs used forSearchableEvent
.- See Also:
-
SEARCHABLE_LAST
public static final int SEARCHABLE_LASTThe last number in the range of IDs used forSearchableEvent
.- See Also:
-
SEARCHABLE_START
public static final int SEARCHABLE_STARTTo indicate the searching process started. It is fired when the search popup shows up.- See Also:
-
SEARCHABLE_END
public static final int SEARCHABLE_ENDTo indicate the searching process stopped. It is fired when the search popup is gone.- See Also:
-
SEARCHABLE_MATCH
public static final int SEARCHABLE_MATCHTo indicate the searching process finds a matching element. In this case,getSearchingText()
will return the text that is being searched for.getMatchingObject()
will return the element that matches the searching text.getMatchingText()
is the text converting from the the matching object.- See Also:
-
SEARCHABLE_NOMATCH
public static final int SEARCHABLE_NOMATCHTo indicate the searching process doesn't find a matching element. In this case,getSearchingText()
will return the text that is being searched for.getMatchingObject()
andgetMatchingText()
will be null.- See Also:
-
SEARCHABLE_CHANGE
public static final int SEARCHABLE_CHANGETo indicate the searching text changes. In this case,getSearchingText()
will return the text that is being searched for.getOldSearchingText()
will return the previous searching text.- See Also:
-
SEARCHABLE_MODEL_CHANGE
public static final int SEARCHABLE_MODEL_CHANGETo indicate the search component model is changed. The model could be ListModel in the case of JList, TableModel in the case of JTable, etc.- See Also:
-
-
Constructor Details
-
SearchableEvent
Creates aSearchableEvent
.- Parameters:
source
-id
-
-
SearchableEvent
Creates aSearchableEvent
. The searching text is the text that is being searched for.- Parameters:
source
-id
-searchingText
-
-
SearchableEvent
-
SearchableEvent
-
-
Method Details
-
paramString
Returns a parameter string identifying this event. This method is useful for event logging and for debugging.- Overrides:
paramString
in classAWTEvent
- Returns:
- a string identifying the event and its attributes
-
getSearchable
Returns the originator of the event.- Returns:
- the
Searchable
object that originated the event
-
getSearchingText
Gets the text that is being searched for. The returned value is valid for events SEARCHABLE_START, SEARCHABLE_MATCH, SEARCHABLE_NOMATCH, and SEARCHABLE_CHANGE.- Returns:
- the text that is being searched for.
-
getOldSearchingText
Gets the text that was searched for. The returned value is only valid for event SEARCHABLE_CHANGE.- Returns:
- the text that was searched for.
-
getMatchingText
Gets the text that is converted from the object matching the searching text. The returned value is only valid for events SEARCHABLE_MATCH.- Returns:
- the text that is converted from the object matching the searching text.
-
getMatchingObject
Gets the object that matches the searching text. The returned value is only valid for events SEARCHABLE_MATCH.- Returns:
- Gets the object that matches the searching text.
-