| org.netbeans.editor.AdjustFinder
AdjustFinder | public interface AdjustFinder extends Finder(Code) | | Advanced finder that can adjust the start and limit position of the search.
The finder can be used in the BaseDocument.find() which calls its
adjust-methods automatically. The order of the methods called for the search
is
1. adjustStartPos() is called
2. adjustStartPos() is called
3. reset() is called
If the search is void i.e. doc.find(finder, pos, pos) is called,
no adjust-methods are called, only the reset() is called. For
backward search the start-position is higher than the limit-position. The
relation startPos < endPos defines whether the search will be
forward or backward. The adjust-methods could in fact revert this relation
turning the forward search into the backward one and vice versa. This is not
allowed. If that happens the search is considered void. The adjust-methods
must NOT use the shortcut -1 for the end of document.
author: Miloslav Metelka version: 1.00 |
Method Summary | |
public int | adjustLimitPos(BaseDocument doc, int limitPos) Adjust the limit position of the search (it's the position where the
search will end) to be either the same or greater.
Parameters: doc - document to search on Parameters: limitPos - limit position originally requested inBaseDocument.find() possibly modified limit position. | public int | adjustStartPos(BaseDocument doc, int startPos) Adjust start position of the search to be either the same or lower. |
adjustLimitPos | public int adjustLimitPos(BaseDocument doc, int limitPos)(Code) | | Adjust the limit position of the search (it's the position where the
search will end) to be either the same or greater.
Parameters: doc - document to search on Parameters: limitPos - limit position originally requested inBaseDocument.find() possibly modified limit position. The returned position must bethe same or greater than the original limit position. |
adjustStartPos | public int adjustStartPos(BaseDocument doc, int startPos)(Code) | | Adjust start position of the search to be either the same or lower. This
method can be used for example to scan the whole line by the reg-exp
finder even if the original start position is not at the begining of the
line. Although it's not specifically checked the finder should NOT in any
case return the position that is lower than the original
Parameters: doc - document to search on Parameters: startPos - start position originally requested inBaseDocument.find(). possibly modified start position. The returned position must bethe same or lower than the original start position for forwardsearch and the same or high. |
|
|