org.gradle.gradleplugin.userinterface.swing.common

Class TextPaneSearchInteraction

java.lang.Object

org.gradle.gradleplugin.userinterface.swing.common.TextPaneSearchInteraction

All Implemented Interfaces:

SearchPanel.SearchInteraction

public class TextPaneSearchInteraction
extends Object
implements SearchPanel.SearchInteraction

A search interaction that searches a JTextPane and highlights matches. Note: there's something kind of goofy here. This draws and 'undraws' highlights on text (using AttributeSets). If you use this and you draw your own highlights in the JTextPane, you need to override removeResultHighlights() and reset your AttributeSets. Otherwise, this assumes there is a default style that all non-highlighted text uses.

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
TextPaneSearchInteraction(JTextPane textComponentToSearch, AttributeSet defaultStyle, AttributeSet highlightStyle, AttributeSet emphasizedHighlightStyle)

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	highlightText(int startingIndex, int endingIndex, boolean ensureVisible, boolean isEmphasized) This highlights the text within the specified range
void	removeResultHighlights() Call this to remove the highlights of the search results.
void	removeTextHighlightText(int startingIndex, int endingIndex) This removes the highlight from the specified existing text.
void	searchComplete(TextBlockSearchEditor editor) Notification that the search was complete and we have results to show to the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextPaneSearchInteraction

public TextPaneSearchInteraction(JTextPane textComponentToSearch,
                         AttributeSet defaultStyle,
                         AttributeSet highlightStyle,
                         AttributeSet emphasizedHighlightStyle)

Method Detail

searchComplete

public void searchComplete(TextBlockSearchEditor editor)

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

Specified by:

searchComplete in interface SearchPanel.SearchInteraction

removeResultHighlights

public void removeResultHighlights()

Call this to remove the highlights of the search results. Override this if you draw your own highlights and you'll probably just want to reset the AttributeSets to the entire text (and not call this (super)).

Specified by:

removeResultHighlights in interface SearchPanel.SearchInteraction

removeTextHighlightText

public void removeTextHighlightText(int startingIndex,
                           int endingIndex)

This removes the highlight from the specified existing text. Unfortunately, it always sets it to the default style. So it removes any previous styling.

getTextToSearch

public String getTextToSearch()

Specified by:

getTextToSearch in interface SearchPanel.SearchInteraction

Returns:

the block of text that we're going to search

getCaretLocation

public int getCaretLocation()

Specified by:

getCaretLocation in interface SearchPanel.SearchInteraction

Returns:

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

highlightAndScrollToResult

public void highlightAndScrollToResult(TextBlockSearchEditor editor,
                              TextBlockSearchEditor.SearchResult searchResult)

Highlight and then ensure this result is visible.

Specified by:

highlightAndScrollToResult in interface SearchPanel.SearchInteraction

Parameters:

editor - the editor that was used to search

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

highlightText

public void highlightText(int startingIndex,
                 int endingIndex,
                 boolean ensureVisible,
                 boolean isEmphasized)

This highlights the text within the specified range

Parameters:

startingIndex - where to start the highlight

endingIndex - where to end the highlight

ensureVisible - true to scroll to the text

isEmphasized - true to use an emphasized highlight (versus a regular highlight). Useful for showing the 'current' highlighted result.