SearchContext

java.lang.Object
- com.fr.design.gui.syntax.ui.rtextarea.SearchContext

所有已实现的接口:

java.lang.Cloneable
```
public class SearchContext
extends java.lang.Object
implements java.lang.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.

版本:

2.0

作者:

Robert Futrell

另请参阅:
SearchEngine

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`PROPERTY_MARK_ALL` Fired when the user toggles the "Mark All" property.
`static java.lang.String`	`PROPERTY_MATCH_CASE` Fired when the "match case" property is toggled.
`static java.lang.String`	`PROPERTY_MATCH_WHOLE_WORD` Fired when the "whole word" property is toggled.
`static java.lang.String`	`PROPERTY_REPLACE_WITH` Fired when the "replace with" property is modified.
`static java.lang.String`	`PROPERTY_SEARCH_FOR` Fired when the "search for" property is modified.
`static java.lang.String`	`PROPERTY_SEARCH_FORWARD` Fired when search direction is toggled.
`static java.lang.String`	`PROPERTY_SELECTION_ONLY` Fired when "search in selection" is toggled (not currently supported).
`static java.lang.String`	`PROPERTY_USE_REGEX` Fired when "use regular expressions" is toggled.

构造器概要

构造器
构造器和说明
`SearchContext()` Creates a new search context.
`SearchContext(java.lang.String searchFor)` Creates a new search context.
`SearchContext(java.lang.String searchFor, boolean matchCase)` Creates a new search context.

方法概要

方法
限定符和类型	方法和说明
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener l)` Adds a property change listener to this context.
`SearchContext`	`clone()`
`protected void`	`firePropertyChange(java.lang.String property, boolean oldValue, boolean newValue)`
`protected void`	`firePropertyChange(java.lang.String property, java.lang.String oldValue, java.lang.String newValue)`
`boolean`	`getMarkAll()` Returns whether "mark all" should be selected or enabled.
`boolean`	`getMatchCase()` Returns whether case should be honored while searching.
`java.lang.String`	`getReplaceWith()` Returns the text to replace with, if doing a replace operation.
`java.lang.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(java.beans.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(java.lang.String replaceWith)` Sets the text to replace with, if doing a replace operation.
`void`	`setSearchFor(java.lang.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.
`java.lang.String`	`toString()`

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - PROPERTY_SEARCH_FOR
```
public static final java.lang.String PROPERTY_SEARCH_FOR
```
    Fired when the "search for" property is modified.
    
    另请参阅:
    常量字段值
  - PROPERTY_REPLACE_WITH
```
public static final java.lang.String PROPERTY_REPLACE_WITH
```
    Fired when the "replace with" property is modified.
    
    另请参阅:
    常量字段值
  - PROPERTY_MATCH_CASE
```
public static final java.lang.String PROPERTY_MATCH_CASE
```
    Fired when the "match case" property is toggled.
    
    另请参阅:
    常量字段值
  - PROPERTY_MATCH_WHOLE_WORD
```
public static final java.lang.String PROPERTY_MATCH_WHOLE_WORD
```
    Fired when the "whole word" property is toggled.
    
    另请参阅:
    常量字段值
  - PROPERTY_SEARCH_FORWARD
```
public static final java.lang.String PROPERTY_SEARCH_FORWARD
```
    Fired when search direction is toggled.
    
    另请参阅:
    常量字段值
  - PROPERTY_SELECTION_ONLY
```
public static final java.lang.String PROPERTY_SELECTION_ONLY
```
    Fired when "search in selection" is toggled (not currently supported).
    
    另请参阅:
    常量字段值
  - PROPERTY_USE_REGEX
```
public static final java.lang.String PROPERTY_USE_REGEX
```
    Fired when "use regular expressions" is toggled.
    
    另请参阅:
    常量字段值
  - PROPERTY_MARK_ALL
```
public static final java.lang.String PROPERTY_MARK_ALL
```
    Fired when the user toggles the "Mark All" property.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - SearchContext
```
public SearchContext()
```
    Creates a new search context. Specifies a forward search, case-insensitive, not whole-word, not a regular expression.
  - SearchContext
```
public SearchContext(java.lang.String searchFor)
```
    Creates a new search context. Specifies a forward search, case-insensitive, not whole-word, not a regular expression.
    
    参数:
    searchFor - The text to search for.
  - SearchContext
```
public SearchContext(java.lang.String searchFor,
             boolean matchCase)
```
    Creates a new search context. Specifies a forward search, not whole-word, not a regular expression.
    
    参数:
    searchFor - The text to search for.
    matchCase - Whether to do a case-sensitive search.
- 方法详细资料
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
```
    Adds a property change listener to this context.
    
    参数:
    l - The new listener.
    另请参阅:
    removePropertyChangeListener(PropertyChangeListener)
  - clone
```
public SearchContext clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object
  - firePropertyChange
```
protected void firePropertyChange(java.lang.String property,
                      boolean oldValue,
                      boolean newValue)
```
  - firePropertyChange
```
protected void firePropertyChange(java.lang.String property,
                      java.lang.String oldValue,
                      java.lang.String newValue)
```
  - getMarkAll
```
public boolean getMarkAll()
```
    Returns whether "mark all" should be selected or enabled.
    
    返回:
    Whether "mark all" should be enabled.
    另请参阅:
    setMarkAll(boolean)
  - getMatchCase
```
public boolean getMatchCase()
```
    Returns whether case should be honored while searching.
    
    返回:
    Whether case should be honored.
    另请参阅:
    setMatchCase(boolean)
  - getReplaceWith
```
public java.lang.String getReplaceWith()
```
    Returns the text to replace with, if doing a replace operation.
    
    返回:
    The text to replace with.
    另请参阅:
    setReplaceWith(String), getSearchFor()
  - getSearchFor
```
public java.lang.String getSearchFor()
```
    Returns the text to search for.
    
    返回:
    The text to search for.
    另请参阅:
    setSearchFor(String), getReplaceWith()
  - getSearchForward
```
public boolean getSearchForward()
```
    Returns whether the search should be forward through the text (vs. backwards).
    
    返回:
    Whether we should search forwards.
    另请参阅:
    setSearchForward(boolean)
  - getSearchSelectionOnly
```
public boolean getSearchSelectionOnly()
```
    Returns whether the search should only be done in the selected text. This flag is currently not supported.
    
    返回:
    Whether only the selected text should be searched.
    另请参阅:
    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.
    
    返回:
    Whether only "whole word" matches should be returned.
    另请参阅:
    setWholeWord(boolean)
  - isRegularExpression
```
public boolean isRegularExpression()
```
    Returns whether a regular expression search should be done.
    
    返回:
    Whether a regular expression search should be done.
    另请参阅:
    setRegularExpression(boolean)
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
```
    Removes a property change listener from this context.
    
    参数:
    l - The listener to remove.
    另请参阅:
    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.
    
    参数:
    markAll - Whether "mark all" should be enabled.
    另请参阅:
    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.
    
    参数:
    matchCase - Whether case should be honored.
    另请参阅:
    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
    
    参数:
    regex - Whether a regular expression search should be done.
    另请参阅:
    isRegularExpression()
  - setReplaceWith
```
public void setReplaceWith(java.lang.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.
    
    参数:
    replaceWith - The text to replace with.
    另请参阅:
    getReplaceWith(), setSearchFor(String)
  - setSearchFor
```
public void setSearchFor(java.lang.String searchFor)
```
    Sets the text to search for. This method fires a property change event of type PROPERTY_SEARCH_FOR.
    
    参数:
    searchFor - The text to search for.
    另请参阅:
    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.
    
    参数:
    forward - Whether we should search forwards.
    另请参阅:
    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.
    
    参数:
    selectionOnly - Whether only selected text should be searched.
    另请参阅:
    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.
    
    参数:
    wholeWord - Whether only "whole word" matches should be returned.
    另请参阅:
    getWholeWord()
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object

类 SearchContext

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

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

构造器详细资料

SearchContext

SearchContext

SearchContext

方法详细资料

addPropertyChangeListener

clone

firePropertyChange

firePropertyChange

getMarkAll

getMatchCase

getReplaceWith

getSearchFor

getSearchForward

getSearchSelectionOnly

getWholeWord

isRegularExpression

removePropertyChangeListener

setMarkAll

setMatchCase

setRegularExpression

setReplaceWith

setSearchFor

setSearchForward

setSearchSelectionOnly

setWholeWord

toString