public static final class FinderFactory.VisColPosFwdFinder extends FinderFactory.AbstractFinder
The starting position for find should be the start of particular
line. The found position will be that position in document
that corresponds to the column position. This method can be used only
in case the font is superfixed i.e. all the characters of all
font styles have the same width.
|Constructor and Description
|Modifier and Type
|Method and Description
finds BOL on current line
Mark that first call will follow
Set visual column that this finder will try to reach
public void setVisCol(int visCol)
public void setTabSize(int tabSize)
public void reset()
public int find(int bufferStartPos, char buffer, int offset1, int offset2, int reqPos, int limitPos)
bufferStartPos - begining position of the buffer (not search area).
buffer - buffer with chars to be searched
offset1 - offset of begining of searchable area in buffer.
No searching below this offset can be performed.
offset2 - offset of end of searchable area in buffer.
No searching beyond this offset can be performed.
reqPos - required position. Initially it is the begining
search position requested by caller. In subsequent calls
it is the same value as returned from previous call
limitPos - is filled with position beyond which search cannot go.
(i.e. forward: pos < limitPos and backward: pos >= limitPos)
Some finders i.e. finder that tries to find some word with
whole-words-only flag turned on can benefit
from this information. If the searched word is at the very end of
the document the finder wouldn't normally find it as it would request
the next buffer even when the whole word was matched because the finder
needs to find white space to know the word ended there. However this
would be beyond the search area so EOT exception would be raised.
To correctly manage this situation finder must care for limitPos.
When it sees the word and knows this is the last text in document
it signals that it found the word.
method returns the position (not offset) where the string starts
(and must also set some flag resulting to that
method will return true).
If the string was not yet found, the function should return
position (not offset) where the next search should continue. If this
position is greater or equal than limit position
(lower than limit position for backward search),
searching will stop resulting in -1 as returned position.
The position returned will be passed as
reqPos in next