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:
  • Field Details

    • SEARCHABLE_FIRST

      public static final int SEARCHABLE_FIRST
      The first number in the range of IDs used for SearchableEvent.
      See Also:
    • SEARCHABLE_LAST

      public static final int SEARCHABLE_LAST
      The last number in the range of IDs used for SearchableEvent.
      See Also:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
  • Constructor Details

    • 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 Details

    • 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.