com.jidesoft.search
Class FindAndReplaceEvent

java.lang.Object
  java.util.EventObject
      com.jidesoft.search.FindAndReplaceEvent

All Implemented Interfaces:

Serializable

public class FindAndReplaceEvent
extends EventObject

The event to represent a change during finding and replacing. Each event will have a status id and some optional fields depending on what kind of status it is. See below for a list of possible status and which optional fields are available in each status.

• SEARCH_STARTED: this event is fired when searching or replacing starts. There is no data in this event.
• SEARCH_STARTED_TEXT: this event is fired when it starts to work on a new piece of text. getTargetName() will give you the new name. This event will fire even if you just have one piece of text, so you can always use this event to find out the name of the text. During searching-all, you can use the name to display a status message so that user knows
• SEARCH_FINISHED: this event is fired when searching or replacing is done. If you are doing a searching-all, getFindResults() will tell you all the find results. If you are doing a interactive searching/replacing, getFindResults() will be null.
• SEARCH_FINISHED_TEXT: this event is fired when searching or replacing is done with a piece of text. If you are doing a searching-all, getFindResults() will tell you all the find results. If you are doing an interactive searching/replacing, getFindResults() will be null. In either case, getTargetName() will always tell you the text name, just like in SEARCH_STARTED_TEXT.
• SEARCH_FOUND: This event is fired when a matching text is found. getFindResult() will always be a non-null value which tells you the start and end offset of the matching text. This event is fired for both interactive search and search-all.
• SEARCH_REPLACED: This event is fired when a matching text is found and replaced with the replacement text. getFindResult() will always be a non-null value which tells you the start and end offset of the matching text. getReplaceText() will tell you the replacement text. This event is fired for both interactive replace and replace-all.

  See Also:

  Serialized Form

  Field Summary

  static int	SEARCH_FINISHED
  static int	SEARCH_FINISHED_TEXT
  static int	SEARCH_FOUND
  static int	SEARCH_REPLACED
  static int	SEARCH_STARTED
  static int	SEARCH_STARTED_TEXT

  Fields inherited from class java.util.EventObject

  source

  Constructor Summary

  FindAndReplaceEvent(Object source, int id)
  

  FindAndReplaceEvent(Object source, int status, FindResult findResult)
  

  FindAndReplaceEvent(Object source, int status, FindResults findResults)
  

  FindAndReplaceEvent(Object source, int status, FindResult findResult, String replaceString)
  

  FindAndReplaceEvent(Object source, int status, String targetName)
  

  FindAndReplaceEvent(Object source, int status, String targetName, FindResults findResults)
  

  Method Summary

  FindResult	getFindResult()
  FindResults	getFindResults()
  String	getReplaceText()
  int	getStatus()
  String	getTargetName()
  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

  Field Detail

  SEARCH_STARTED

  public static final int SEARCH_STARTED

  See Also:

  Constant Field Values

  SEARCH_STARTED_TEXT

  public static final int SEARCH_STARTED_TEXT

  See Also:

  Constant Field Values

  SEARCH_FINISHED

  public static final int SEARCH_FINISHED

  See Also:

  Constant Field Values

  SEARCH_FINISHED_TEXT

  public static final int SEARCH_FINISHED_TEXT

  See Also:

  Constant Field Values

  SEARCH_FOUND

  public static final int SEARCH_FOUND

  See Also:

  Constant Field Values

  SEARCH_REPLACED

  public static final int SEARCH_REPLACED

  See Also:

  Constant Field Values

  Constructor Detail

  FindAndReplaceEvent

  public FindAndReplaceEvent(Object source,
                             int id)

  FindAndReplaceEvent

  public FindAndReplaceEvent(Object source,
                             int status,
                             FindResult findResult)

  FindAndReplaceEvent

  public FindAndReplaceEvent(Object source,
                             int status,
                             String targetName,
                             FindResults findResults)

  FindAndReplaceEvent

  public FindAndReplaceEvent(Object source,
                             int status,
                             FindResults findResults)

  FindAndReplaceEvent

  public FindAndReplaceEvent(Object source,
                             int status,
                             String targetName)

  FindAndReplaceEvent

  public FindAndReplaceEvent(Object source,
                             int status,
                             FindResult findResult,
                             String replaceString)

  Method Detail

  getStatus

  public int getStatus()

  getFindResult

  public FindResult getFindResult()

  getFindResults

  public FindResults getFindResults()

  getTargetName

  public String getTargetName()

  getReplaceText

  public String getReplaceText()

  toString

  public String toString()

  Overrides:

  toString in class EventObject