oracle.javatools.editor.find

Class FindCriteria

java.lang.Object

oracle.javatools.editor.find.FindCriteria

public final class FindCriteria
extends java.lang.Object

A class defining what the finder should look for, and how it should do it.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FindCriteria.Direction Which way to find.

Constructor Summary

Constructors

Constructor and Description
FindCriteria(java.lang.String text)

Method Summary

Modifier and Type	Method and Description
FindCriteria.Direction	getDirection()
int	getLocation()
int	getLowerBound()
java.lang.String	getText()
int	getUpperBound()
boolean	isHighlight()
boolean	isMatchCase()
boolean	isRegEx()
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	setRegEx(boolean regEx) If true, the search text is used as a regular expression pattern.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FindCriteria

public FindCriteria(java.lang.String text)

Method Detail

setText

public void setText(java.lang.String text)

Set the text or reg ex to search for.

Parameters:

text -

getText

public java.lang.String getText()

setRegEx

public void setRegEx(boolean regEx)

If true, the search text is used as a regular expression pattern.

Parameters:

regEx -

isRegEx

public boolean isRegEx()

setMatchCase

public void setMatchCase(boolean matchCase)

Set to restrict finding to matching case. Defaults to false.

Parameters:

matchCase -

isMatchCase

public boolean isMatchCase()

setWholeWord

public void setWholeWord(boolean wholeWord)

Will restrict finding to searches that are whole words. i.e. are immediately surrounded by word boundaries. Defaults to false.

Parameters:

wholeWord -

isWholeWord

public boolean isWholeWord()

setLowerBound

public void setLowerBound(int lowerBound)

The lower offset in the document where the search is contained. Defaults to 0.

Parameters:

lowerBound -

getLowerBound

public int getLowerBound()

setUpperBound

public void setUpperBound(int upperBound)

The offset in the document after which searching will not be performed. Matches must be fully within this offset and not cross this boundary.

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.

Parameters:

upperBound - higher offset boundary. Matches will not be found after this offset, or -1 to end at the end of the document.

getUpperBound

public int getUpperBound()

setLocation

public void setLocation(int location)

The position in the document from where to find the next match. If it is not set (-1) then the location will begin based on the current caret selection in the editor.

Parameters:

location -

getLocation

public int getLocation()

setWrap

public void setWrap(boolean wrap)

If true the search will wrap within the current bounds.

Parameters:

wrap -

isWrap

public boolean isWrap()

setDirection

public void setDirection(FindCriteria.Direction direction)

The direction in which to search

Parameters:

findType -

getDirection

public FindCriteria.Direction getDirection()

setHighlight

public void setHighlight(boolean highlight)

If true, all matches will be highlighted in the editor

Parameters:

highlight -

isHighlight

public boolean isHighlight()