org.eclipse.jface.text
Class FindReplaceDocumentAdapter

java.lang.Object
  org.eclipse.jface.text.FindReplaceDocumentAdapter

All Implemented Interfaces:

CharSequence

public class FindReplaceDocumentAdapter

extends Object

implements CharSequence

Adapts IDocument for doing search and replace operations.

Since:

3.0

Constructor Summary

FindReplaceDocumentAdapter(IDocument document)
Constructs a new find replace document adapter.

Method Summary

char	charAt(int index)
IRegion	findReplace(FindReplaceOperationCode operationCode, int startOffset, String findString, String replaceText, boolean forwardSearch, boolean caseSensitive, boolean wholeWord, boolean regExSearch) Stateful findReplace executes a FIND, REPLACE, REPLACE_FIND or FIND_FIRST operation.
int	length()
IRegion	replace(String text, boolean regExReplace) Subsitutes the previous match with the given text.
IRegion	search(int startOffset, String findString, boolean forwardSearch, boolean caseSensitive, boolean wholeWord, boolean regExSearch) Returns the region of a given search string in the document based on a set of search criteria.
CharSequence	subSequence(int start, int end)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FindReplaceDocumentAdapter

public FindReplaceDocumentAdapter(IDocument document)

Constructs a new find replace document adapter.

Parameters:

document - the adapted document

Method Detail

search

public IRegion search(int startOffset,
                      String findString,
                      boolean forwardSearch,
                      boolean caseSensitive,
                      boolean wholeWord,
                      boolean regExSearch)
               throws BadLocationException

Returns the region of a given search string in the document based on a set of search criteria.

Parameters:

startOffset - document offset at which search starts

findString - the string to find

forwardSearch - the search direction

caseSensitive - indicates whether lower and upper case should be distinguished

wholeWord - indicates whether the findString should be limited by white spaces as defined by Character.isWhiteSpace. Must not be used in combination with regExSearch.

regExSearch - if true findString represents a regular expression Must not be used in combination with regExSearch.

Returns:

the find or replace region or null if there was no match

Throws:

BadLocationException - if startOffset is an invalid document offset

PatternSyntaxException - if a regular expression has invalid syntax

findReplace

public IRegion findReplace(FindReplaceOperationCode operationCode,
                           int startOffset,
                           String findString,
                           String replaceText,
                           boolean forwardSearch,
                           boolean caseSensitive,
                           boolean wholeWord,
                           boolean regExSearch)
                    throws BadLocationException

Stateful findReplace executes a FIND, REPLACE, REPLACE_FIND or FIND_FIRST operation. In case of REPLACE and REPLACE_FIND it sends a DocumentEvent to all registered IDocumentListener.

Parameters:

startOffset - document offset at which search starts this value is only used in the FIND_FIRST operation and otherwise ignored

findString - the string to find this value is only used in the FIND_FIRST operation and otherwise ignored

forwardSearch - the search direction

caseSensitive - indicates whether lower and upper case should be distinguished

wholeWord - indicates whether the findString should be limited by white spaces as defined by Character.isWhiteSpace. Must not be used in combination with regExSearch.

regExSearch - if true this operation represents a regular expression Must not be used in combination with wholeWord.

operationCode - specifies what kind of operation is executed

Returns:

the find or replace region or null if there was no match

Throws:

BadLocationException - if startOffset is an invalid document offset

IllegalStateException - if a REPLACE or REPLACE_FIND operation is not preceded by a successful FIND operation

PatternSyntaxException - if a regular expression has invalid syntax

See Also:

FindReplaceOperationCode.FIND_FIRST, FindReplaceOperationCode.FIND_NEXT, FindReplaceOperationCode.REPLACE, FindReplaceOperationCode.REPLACE_FIND_NEXT

replace

public IRegion replace(String text,
                       boolean regExReplace)
                throws BadLocationException

Subsitutes the previous match with the given text. Sends a DocumentEvent to all registered IDocumentListener.

Parameters:

text - the substitution text

Returns:

the replace region or null if there was no match

Throws:

BadLocationException - if startOffset is an invalid document offset

IllegalStateException - if a REPLACE or REPLACE_FIND operation is not preceded by a successful FIND operation

PatternSyntaxException - if a regular expression has invalid syntax

See Also:

DocumentEvent, IDocumentListener

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                                int end)

Specified by:

subSequence in interface CharSequence

toString

public String toString()

Specified by:

toString in interface CharSequence