public final class FindCriteria
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
FindCriteria.Direction
Which way to find.
|
static class |
FindCriteria.Scope
Scope of operation
|
Constructor and Description |
---|
FindCriteria(java.lang.String text) |
Modifier and Type | Method and Description |
---|---|
FindCriteria.Direction |
getDirection() |
int |
getLocation() |
int |
getLowerBound() |
java.lang.String |
getReplaceText() |
FindCriteria.Scope |
getScope() |
java.lang.String |
getText() |
int |
getUpperBound() |
boolean |
isHighlight() |
boolean |
isMatchCase() |
boolean |
isPreserveCase() |
boolean |
isRegEx() |
boolean |
isSubstituteReplace() |
boolean |
isWholeWord() |
boolean |
isWrap() |
void |
setDirection(FindCriteria.Direction direction)
The direction in which to search
|
void |
setHighlight(boolean highlight)
If true, all matches will be highlighted in the editor
|
void |
setLocation(int location)
The position in the document from where to find the next match.
|
void |
setLowerBound(int lowerBound)
The lower offset in the document where the search is contained.
|
void |
setMatchCase(boolean matchCase)
Set to restrict finding to matching case.
|
void |
setPreserveCase(boolean preserveCase)
When replacing, the case of the inserted text will try to match the case of the removed text,
|
void |
setRegEx(boolean regEx)
If true, the search text is used as a regular expression pattern.
|
void |
setReplaceText(java.lang.String replaceText)
Set the text that will replace finds.
|
void |
setScope(FindCriteria.Scope scope)
Set the scope of the operation
|
void |
setSubstituteSpecial(boolean substituteSpecial)
If true special characters in the replacement text will substituted.
|
void |
setText(java.lang.String text)
Set the text or reg ex to search for.
|
void |
setUpperBound(int upperBound)
The offset in the document after which searching will not be performed.
|
void |
setWholeWord(boolean wholeWord)
Will restrict finding to searches that are whole words.
|
void |
setWrap(boolean wrap)
If true the search will wrap within the current bounds.
|
public void setText(java.lang.String text)
text
- public java.lang.String getText()
public void setReplaceText(java.lang.String replaceText)
text
- public java.lang.String getReplaceText()
public void setRegEx(boolean regEx)
regEx
- public boolean isRegEx()
public void setMatchCase(boolean matchCase)
matchCase
- public boolean isMatchCase()
public void setPreserveCase(boolean preserveCase)
e.g. "FIND" -> "REPLACE", "find"->"replace", "Find"->"Replace"
preserveCase
- public boolean isPreserveCase()
public void setWholeWord(boolean wholeWord)
wholeWord
- public boolean isWholeWord()
public void setLowerBound(int lowerBound)
lowerBound
- public int getLowerBound()
public void setUpperBound(int upperBound)
Defaults to -1, which indicates the end of the document.
The upper bound must be greater than the lower bound, else a IllegalStateException will be thrown when the call to find occurs.
upperBound
- higher offset boundary. Matches will not be found after this offset, or -1 to end at the end of the document.public int getUpperBound()
public void setLocation(int location)
location
- public int getLocation()
public void setWrap(boolean wrap)
wrap
- public boolean isWrap()
public void setDirection(FindCriteria.Direction direction)
findType
- public FindCriteria.Direction getDirection()
public void setScope(FindCriteria.Scope scope)
scope
- public FindCriteria.Scope getScope()
public void setHighlight(boolean highlight)
highlight
- public boolean isHighlight()
public void setSubstituteSpecial(boolean substituteSpecial)
substituteSpecial
- public boolean isSubstituteReplace()