org.openide.awt
Interface QuickSearch.Callback

Enclosing class:

QuickSearch

public static interface QuickSearch.Callback

Call back interface, that is notified with the submissions to the quick search field.

Since:

7.43

Method Summary

String	findMaxPrefix(String prefix) Find the maximum prefix among the search results, that starts with the provided string.
void	quickSearchCanceled() Called when the quick search is canceled by the user.
void	quickSearchConfirmed() Called when the quick search is confirmed by the user.
void	quickSearchUpdate(String searchText) Called with an updated search text.
void	showNextSelection(boolean forward) Called to select a next occurrence of the search result.

Method Detail

quickSearchUpdate

void quickSearchUpdate(String searchText)

Called with an updated search text. When #isAsynchronous() is false it's called in EQ thread, otherwise, it's called in a background thread. The client should update the visual representation of the search results and then return.

This method is called to initiate and update the search process.

Parameters:

searchText - The new text to search for.

showNextSelection

void showNextSelection(boolean forward)

Called to select a next occurrence of the search result. When #isAsynchronous() is false it's called in EQ thread, otherwise, it's called in a background thread. The client should update the visual representation of the search results and then return.

Parameters:

forward - The direction of the next search result. true for forward direction, false for backward direction.

findMaxPrefix

String findMaxPrefix(String prefix)

Find the maximum prefix among the search results, that starts with the provided string. This method is called when user press TAB in the search field, to auto-complete the maximum prefix. When #isAsynchronous() is false it's called in EQ thread, otherwise, it's called in a background thread. Utility method QuickSearch.findMaxPrefix(java.lang.String, java.lang.String, boolean) can be used by the implementation.

Parameters:

prefix - The prefix to start with

Returns:

The maximum prefix.

quickSearchConfirmed

void quickSearchConfirmed()

Called when the quick search is confirmed by the user. This method is called in EQ thread always.

quickSearchCanceled

void quickSearchCanceled()

Called when the quick search is canceled by the user. This method is called in EQ thread always.