java.lang.Object
- org.fife.ui.rtextarea.SearchContext

All Implemented Interfaces:

Cloneable
```
public class SearchContext
extends Object
implements Cloneable
```
Contains information about a find/replace operation. Applications can keep an instance of this class around and use it to maintain the user's selection for options such as "match case," "regular expression," etc., between search operations. They can then pass the instance as a parameter to the public SearchEngine methods to do the actual searching.

See Also:

SearchEngine

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`PROPERTY_MARK_ALL`	Fired when the user toggles the "Mark All" property.
`static String`	`PROPERTY_MATCH_CASE`	Fired when the "match case" property is toggled.
`static String`	`PROPERTY_MATCH_WHOLE_WORD`	Fired when the "whole word" property is toggled.
`static String`	`PROPERTY_REPLACE_WITH`	Fired when the "replace with" property is modified.
`static String`	`PROPERTY_SEARCH_FOR`	Fired when the "search for" property is modified.
`static String`	`PROPERTY_SEARCH_FORWARD`	Fired when search direction is toggled.
`static String`	`PROPERTY_SELECTION_ONLY`	Fired when "search in selection" is toggled (not currently supported).
`static String`	`PROPERTY_USE_REGEX`	Fired when "use regular expressions" is toggled.

Constructor Summary

Constructors
Constructor	Description
`SearchContext()`	Creates a new search context.
`SearchContext(String searchFor)`	Creates a new search context.
`SearchContext(String searchFor, boolean matchCase)`	Creates a new search context.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addPropertyChangeListener(PropertyChangeListener l)`	Adds a property change listener to this context.
`SearchContext`	`clone()`
`protected void`	`firePropertyChange(String property, boolean oldValue, boolean newValue)`
`protected void`	`firePropertyChange(String property, String oldValue, String newValue)`
`boolean`	`getMarkAll()`	Returns whether "mark all" should be selected or enabled.
`boolean`	`getMatchCase()`	Returns whether case should be honored while searching.
`String`	`getReplaceWith()`	Returns the text to replace with, if doing a replace operation.
`String`	`getSearchFor()`	Returns the text to search for.
`boolean`	`getSearchForward()`	Returns whether the search should be forward through the text (vs.
`boolean`	`getSearchSelectionOnly()`	Returns whether the search should only be done in the selected text.
`boolean`	`getWholeWord()`	Returns whether only "whole word" matches should be returned.
`boolean`	`isRegularExpression()`	Returns whether a regular expression search should be done.
`void`	`removePropertyChangeListener(PropertyChangeListener l)`	Removes a property change listener from this context.
`void`	`setMarkAll(boolean markAll)`	Sets whether "mark all" should be selected or enabled.
`void`	`setMatchCase(boolean matchCase)`	Sets whether case should be honored while searching.
`void`	`setRegularExpression(boolean regex)`	Sets whether a regular expression search should be done.This method fires a property change event of type `PROPERTY_USE_REGEX`
`void`	`setReplaceWith(String replaceWith)`	Sets the text to replace with, if doing a replace operation.
`void`	`setSearchFor(String searchFor)`	Sets the text to search for.
`void`	`setSearchForward(boolean forward)`	Sets whether the search should be forward through the text (vs.
`void`	`setSearchSelectionOnly(boolean selectionOnly)`	Sets whether only the selected text should be searched.
`void`	`setWholeWord(boolean wholeWord)`	Sets whether only "whole word" matches should be returned.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PROPERTY_SEARCH_FOR
```
public static final String PROPERTY_SEARCH_FOR
```
    Fired when the "search for" property is modified.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_REPLACE_WITH
```
public static final String PROPERTY_REPLACE_WITH
```
    Fired when the "replace with" property is modified.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_MATCH_CASE
```
public static final String PROPERTY_MATCH_CASE
```
    Fired when the "match case" property is toggled.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_MATCH_WHOLE_WORD
```
public static final String PROPERTY_MATCH_WHOLE_WORD
```
    Fired when the "whole word" property is toggled.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SEARCH_FORWARD
```
public static final String PROPERTY_SEARCH_FORWARD
```
    Fired when search direction is toggled.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SELECTION_ONLY
```
public static final String PROPERTY_SELECTION_ONLY
```
    Fired when "search in selection" is toggled (not currently supported).
    
    See Also:
    
    Constant Field Values
  - PROPERTY_USE_REGEX
```
public static final String PROPERTY_USE_REGEX
```
    Fired when "use regular expressions" is toggled.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_MARK_ALL
```
public static final String PROPERTY_MARK_ALL
```
    Fired when the user toggles the "Mark All" property.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SearchContext
```
public SearchContext()
```
    Creates a new search context. Specifies a forward search, case-insensitive, not whole-word, not a regular expression.
  - SearchContext
```
public SearchContext(String searchFor)
```
    Creates a new search context. Specifies a forward search, case-insensitive, not whole-word, not a regular expression.
    
    Parameters:
    
    searchFor - The text to search for.
  - SearchContext
```
public SearchContext(String searchFor,
                     boolean matchCase)
```
    Creates a new search context. Specifies a forward search, not whole-word, not a regular expression.
    
    Parameters:
    
    searchFor - The text to search for.
    
    matchCase - Whether to do a case-sensitive search.
- Method Detail
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener l)
```
    Adds a property change listener to this context.
    
    Parameters:
    
    l - The new listener.
    
    See Also:
    
    removePropertyChangeListener(PropertyChangeListener)
  - clone
```
public SearchContext clone()
```
    Overrides:
    
    clone in class Object
  - firePropertyChange
```
protected void firePropertyChange(String property,
                                  boolean oldValue,
                                  boolean newValue)
```
  - firePropertyChange
```
protected void firePropertyChange(String property,
                                  String oldValue,
                                  String newValue)
```
  - getMarkAll
```
public boolean getMarkAll()
```
    Returns whether "mark all" should be selected or enabled.
    
    Returns:
    
    Whether "mark all" should be enabled.
    
    See Also:
    
    setMarkAll(boolean)
  - getMatchCase
```
public boolean getMatchCase()
```
    Returns whether case should be honored while searching.
    
    Returns:
    
    Whether case should be honored.
    
    See Also:
    
    setMatchCase(boolean)
  - getReplaceWith
```
public String getReplaceWith()
```
    Returns the text to replace with, if doing a replace operation.
    
    Returns:
    
    The text to replace with.
    
    See Also:
    
    setReplaceWith(String), getSearchFor()
  - getSearchFor
```
public String getSearchFor()
```
    Returns the text to search for.
    
    Returns:
    
    The text to search for.
    
    See Also:
    
    setSearchFor(String), getReplaceWith()
  - getSearchForward
```
public boolean getSearchForward()
```
    Returns whether the search should be forward through the text (vs. backwards).
    
    Returns:
    
    Whether we should search forwards.
    
    See Also:
    
    setSearchForward(boolean)
  - getSearchSelectionOnly
```
public boolean getSearchSelectionOnly()
```
    Returns whether the search should only be done in the selected text. This flag is currently not supported.
    
    Returns:
    
    Whether only the selected text should be searched.
    
    See Also:
    
    setSearchSelectionOnly(boolean)
  - getWholeWord
```
public boolean getWholeWord()
```
    Returns whether only "whole word" matches should be returned. A match is considered to be "whole word" if the character on either side of the matched text is a non-word character, or if there is no character on one side of the word, such as when it's at the beginning or end of a line.
    
    Returns:
    
    Whether only "whole word" matches should be returned.
    
    See Also:
    
    setWholeWord(boolean)
  - isRegularExpression
```
public boolean isRegularExpression()
```
    Returns whether a regular expression search should be done.
    
    Returns:
    
    Whether a regular expression search should be done.
    
    See Also:
    
    setRegularExpression(boolean)
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener l)
```
    Removes a property change listener from this context.
    
    Parameters:
    
    l - The listener to remove.
    
    See Also:
    
    addPropertyChangeListener(PropertyChangeListener)
  - setMarkAll
```
public void setMarkAll(boolean markAll)
```
    Sets whether "mark all" should be selected or enabled. This method fires property change events of type PROPERTY_MARK_ALL.
    
    Parameters:
    
    markAll - Whether "mark all" should be enabled.
    
    See Also:
    
    getMarkAll()
  - setMatchCase
```
public void setMatchCase(boolean matchCase)
```
    Sets whether case should be honored while searching. This method fires a property change event of type PROPERTY_MATCH_CASE.
    
    Parameters:
    
    matchCase - Whether case should be honored.
    
    See Also:
    
    getMatchCase()
  - setRegularExpression
```
public void setRegularExpression(boolean regex)
```
    Sets whether a regular expression search should be done.This method fires a property change event of type PROPERTY_USE_REGEX
    
    Parameters:
    
    regex - Whether a regular expression search should be done.
    
    See Also:
    
    isRegularExpression()
  - setReplaceWith
```
public void setReplaceWith(String replaceWith)
```
    Sets the text to replace with, if doing a replace operation. This method fires a property change event of type PROPERTY_REPLACE_WITH.
    
    Parameters:
    
    replaceWith - The text to replace with.
    
    See Also:
    
    getReplaceWith(), setSearchFor(String)
  - setSearchFor
```
public void setSearchFor(String searchFor)
```
    Sets the text to search for. This method fires a property change event of type PROPERTY_SEARCH_FOR.
    
    Parameters:
    
    searchFor - The text to search for.
    
    See Also:
    
    getSearchFor(), setReplaceWith(String)
  - setSearchForward
```
public void setSearchForward(boolean forward)
```
    Sets whether the search should be forward through the text (vs. backwards). This method fires a property change event of type PROPERTY_SEARCH_FORWARD.
    
    Parameters:
    
    forward - Whether we should search forwards.
    
    See Also:
    
    getSearchForward()
  - setSearchSelectionOnly
```
public void setSearchSelectionOnly(boolean selectionOnly)
```
    Sets whether only the selected text should be searched. This method fires a property change event of type PROPERTY_SELECTION_ONLY.
    This flag is currently not supported. Calling this method will throw an UnsupportedOperationException until it is implemented.
    
    Parameters:
    
    selectionOnly - Whether only selected text should be searched.
    
    See Also:
    
    getSearchSelectionOnly()
  - setWholeWord
```
public void setWholeWord(boolean wholeWord)
```
    Sets whether only "whole word" matches should be returned. A match is considered to be "whole word" if the character on either side of the matched text is a non-word character, or if there is no character on one side of the word, such as when it's at the beginning or end of a line.This method fires a property change event of type PROPERTY_MATCH_WHOLE_WORD.
    
    Parameters:
    
    wholeWord - Whether only "whole word" matches should be returned.
    
    See Also:
    
    getWholeWord()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SearchContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_SEARCH_FOR

PROPERTY_REPLACE_WITH

PROPERTY_MATCH_CASE

PROPERTY_MATCH_WHOLE_WORD

PROPERTY_SEARCH_FORWARD

PROPERTY_SELECTION_ONLY

PROPERTY_USE_REGEX

PROPERTY_MARK_ALL

Constructor Detail

SearchContext

SearchContext

SearchContext

Method Detail

addPropertyChangeListener

clone

firePropertyChange

firePropertyChange

getMarkAll

getMatchCase

getReplaceWith

getSearchFor

getSearchForward

getSearchSelectionOnly

getWholeWord

isRegularExpression

removePropertyChangeListener

setMarkAll

setMatchCase

setRegularExpression

setReplaceWith

setSearchFor

setSearchForward

setSearchSelectionOnly

setWholeWord

toString