FinderFactory.PreviousWordBwdFinder (Editor Library) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.lib/1 1.14.0 3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.editor
Class FinderFactory.PreviousWordBwdFinder

java.lang.Object
  org.netbeans.editor.FinderFactory.AbstractFinder
      org.netbeans.editor.FinderFactory.GenericBwdFinder
          org.netbeans.editor.FinderFactory.PreviousWordBwdFinder

All Implemented Interfaces:: Finder

Enclosing class:: FinderFactory

public static class FinderFactory.PreviousWordBwdFinder
extends FinderFactory.GenericBwdFinder
extends FinderFactory.GenericBwdFinder

Find start of the word. This finder can be used to go to previous word or to the start of the current word.

Field Summary

Fields inherited from class org.netbeans.editor.FinderFactory.AbstractFinder

found

Constructor Summary

FinderFactory.PreviousWordBwdFinder(BaseDocument doc, boolean stopOnEOL, boolean stopOnWhitespace)


Method Summary

void reset()
          Reset the finder

protected int scan(char ch, boolean lastChar)
          This function decides if it found a desired string or not.

Methods inherited from class org.netbeans.editor.FinderFactory.GenericBwdFinder

find

Methods inherited from class org.netbeans.editor.FinderFactory.AbstractFinder

isFound

Methods inherited from class java.lang.Object

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

Fields inherited from class org.netbeans.editor.FinderFactory.AbstractFinder
`found`

Constructor Summary
`FinderFactory.PreviousWordBwdFinder(BaseDocument doc, boolean stopOnEOL, boolean stopOnWhitespace)`

Method Summary
`void`	`reset()` Reset the finder
`protected int`	`scan(char ch, boolean lastChar)` This function decides if it found a desired string or not.

Methods inherited from class org.netbeans.editor.FinderFactory.GenericBwdFinder
`find`

Methods inherited from class org.netbeans.editor.FinderFactory.AbstractFinder
`isFound`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

FinderFactory.PreviousWordBwdFinder

public FinderFactory.PreviousWordBwdFinder(BaseDocument doc,
                                           boolean stopOnEOL,
                                           boolean stopOnWhitespace)

Method Detail

reset

public void reset()

Description copied from class: FinderFactory.AbstractFinder

Reset the finder

Specified by:: reset in interface Finder
Overrides:: reset in class FinderFactory.AbstractFinder

scan

protected int scan(char ch,
                   boolean lastChar)

Description copied from class: FinderFactory.GenericBwdFinder

This function decides if it found a desired string or not. The function receives currently searched character and flag if it's the last one that is searched or not.

Specified by:: scan in class FinderFactory.GenericBwdFinder

Returns:: if the function decides that it found a desired string it sets found = true and returns how many characters back the searched string begins in backward direction (0 stands for current character). It is usually 0 as the finder usually decides after the last required character but it's not always the case e.g. for whole-words-only search it can be 1 or so. If the string is not yet found it returns how many characters it should go in backward direction (in this case it would usually be -1). The next searched character will be that one requested.