oracle.javatools.editor.find

Class Finder

java.lang.Object

oracle.javatools.editor.find.Finder

public final class Finder
extends java.lang.Object

Utility class to find text in an editor.

When the Finder is no longer used, dispose() must be called to free up resources.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HIGHLIGHT_FIND_RESULT

Method Summary

Modifier and Type	Method and Description
static void	clearHighlights(BasicEditorPane editor) Remove all find highlights from the editor
static void	dispose(BasicEditorPane editor) Clean up an editor when finding in it is no longer needed.
static FindResult	find(BasicEditorPane editor, FindCriteria criteria) Find according to the passed parameters.
static HighlightStyle	getFindStyle()
static FindResult	getLatestFindResult(BasicEditorPane editor) Get the FindResult for the given editor created by the latest call to find.
static boolean	hasHighlights(BasicEditorPane editor)
static void	highlight(BasicEditorPane editor, java.util.List<Find> finds)
static void	main(java.lang.String[] args)

Methods inherited from class java.lang.Object

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

Field Detail

HIGHLIGHT_FIND_RESULT

public static final java.lang.String HIGHLIGHT_FIND_RESULT

See Also:

Constant Field Values

Method Detail

dispose

public static void dispose(BasicEditorPane editor)

Clean up an editor when finding in it is no longer needed.

Parameters:

editor -

getFindStyle

public static HighlightStyle getFindStyle()

Returns:

the highlight style used for find occurrances.

highlight

public static void highlight(BasicEditorPane editor,
                             java.util.List<Find> finds)

hasHighlights

public static boolean hasHighlights(BasicEditorPane editor)

clearHighlights

public static void clearHighlights(BasicEditorPane editor)

Remove all find highlights from the editor

Parameters:

editor -

find

public static FindResult find(BasicEditorPane editor,
                              FindCriteria criteria)

Find according to the passed parameters.

Parameters:

editor - the editor in which to do the finding

criteria - what to look for.

Returns:

the result object, or null if no item was found.

getLatestFindResult

public static FindResult getLatestFindResult(BasicEditorPane editor)

Get the FindResult for the given editor created by the latest call to find.

Parameters:

editor -

Returns:

the result of the last call to 'find' for this editor.

main

public static void main(java.lang.String[] args)