com.jidesoft.swing.event

Class SearchableEvent

java.lang.Object

java.util.EventObject

java.awt.AWTEvent

com.jidesoft.swing.event.SearchableEvent

All Implemented Interfaces:

Serializable

public class SearchableEvent
extends AWTEvent

An AWTEvent that adds support for SearchableEvent objects as the event source.

See Also:

Searchable, SearchableListener, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	SEARCHABLE_CHANGE To indicate the searching text changes.
static int	SEARCHABLE_END To indicate the searching process stopped.
static int	SEARCHABLE_FIRST The first number in the range of IDs used for SearchableEvent.
static int	SEARCHABLE_LAST The last number in the range of IDs used for SearchableEvent.
static int	SEARCHABLE_MATCH To indicate the searching process finds a matching element.
static int	SEARCHABLE_MODEL_CHANGE To indicate the search component model is changed.
static int	SEARCHABLE_NOMATCH To indicate the searching process doesn't find a matching element.
static int	SEARCHABLE_START 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

Constructors

Constructor and Description
SearchableEvent(Object source, int id, String searchingText) Creates a SearchableEvent.
SearchableEvent(Object source, int id, String searchingText, Object matchingObject, String matchingText)
SearchableEvent(Object source, int id, String searchingText, String oldSearchingText)
SearchableEvent(Searchable source, int id) Creates a SearchableEvent.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getMatchingObject() Gets the object that matches the searching text.
String	getMatchingText() Gets the text that is converted from the object matching the searching text.
String	getOldSearchingText() Gets the text that was searched for.
Searchable	getSearchable() Returns the originator of the event.
String	getSearchingText() Gets the text that is being searched for.
String	paramString() Returns a parameter string identifying this event.

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, setSource, 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

Field Detail

SEARCHABLE_FIRST

public static final int SEARCHABLE_FIRST

The first number in the range of IDs used for SearchableEvent.

See Also:

Constant Field Values

SEARCHABLE_LAST

public static final int SEARCHABLE_LAST

The last number in the range of IDs used for SearchableEvent.

See Also:

Constant Field Values

SEARCHABLE_START

public static final int SEARCHABLE_START

To indicate the searching process started. It is fired when the search popup shows up.

See Also:

Constant Field Values

SEARCHABLE_END

public static final int SEARCHABLE_END

To indicate the searching process stopped. It is fired when the search popup is gone.

See Also:

Constant Field Values

SEARCHABLE_MATCH

public static final int SEARCHABLE_MATCH

To 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:

Constant Field Values

SEARCHABLE_NOMATCH

public static final int SEARCHABLE_NOMATCH

To indicate the searching process doesn't find a matching element. In this case, getSearchingText() will return the text that is being searched for. getMatchingObject() and getMatchingText() will be null.

See Also:

Constant Field Values

SEARCHABLE_CHANGE

public static final int SEARCHABLE_CHANGE

To 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:

Constant Field Values

SEARCHABLE_MODEL_CHANGE

public static final int SEARCHABLE_MODEL_CHANGE

To 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:

Constant Field Values

Constructor Detail

SearchableEvent

public SearchableEvent(Searchable source,
               int id)

Creates a SearchableEvent.

Parameters:

source -

id -

SearchableEvent

public SearchableEvent(Object source,
               int id,
               String searchingText)

Creates a SearchableEvent. The searching text is the text that is being searched for.

Parameters:

source -

id -

searchingText -

SearchableEvent

public SearchableEvent(Object source,
               int id,
               String searchingText,
               String oldSearchingText)

SearchableEvent

public SearchableEvent(Object source,
               int id,
               String searchingText,
               Object matchingObject,
               String matchingText)

Method Detail

paramString

public String paramString()

Returns a parameter string identifying this event. This method is useful for event logging and for debugging.

Overrides:

paramString in class AWTEvent

Returns:

a string identifying the event and its attributes

getSearchable

public Searchable getSearchable()

Returns the originator of the event.

Returns:

the Searchable object that originated the event

getSearchingText

public String 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

public String 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

public String 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

public Object 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.