org.gradle.gradleplugin.userinterface.swing.common

Interface SearchPanel.SearchInteraction

All Known Implementing Classes:

TextPaneSearchInteraction

Enclosing class:

SearchPanel

public static interface SearchPanel.SearchInteraction

Method Summary

Methods

Modifier and Type	Method and Description
int	getCaretLocation()
String	getTextToSearch()
void	highlightAndScrollToResult(TextBlockSearchEditor editor, TextBlockSearchEditor.SearchResult searchResult) Highlight and then ensure this result is visible.
void	removeResultHighlights() Notification to hide your results.
void	searchComplete(TextBlockSearchEditor editor) Notification that the search was complete and we have results to show to the user.

Method Detail

getTextToSearch

String getTextToSearch()

Returns:

the block of text that we're going to search

getCaretLocation

int getCaretLocation()

Returns:

the current location of hte caret within the text we're going to search.

highlightAndScrollToResult

void highlightAndScrollToResult(TextBlockSearchEditor editor,
                              TextBlockSearchEditor.SearchResult searchResult)

Highlight and then ensure this result is visible.

Parameters:

editor - the editor that was used to search

searchResult - the specific result (within the editor's search results) to highlight.

searchComplete

void searchComplete(TextBlockSearchEditor editor)

Notification that the search was complete and we have results to show to the user.

removeResultHighlights

void removeResultHighlights()

Notification to hide your results. This panel is going away or the user cleared the results.