is.codion.swing.common.ui.component.text

Class SearchHighlighter

java.lang.Object

is.codion.swing.common.ui.component.text.SearchHighlighter

public final class SearchHighlighter
extends Object

Highlights search results in a JTextComponent.
Instantiate via the searchHighlighter(JTextComponent) factory method.

Method Summary

Modifier and Type	Method and Description
State	caseSensitiveState()
JTextField	createSearchField()
static SearchHighlighter	searchHighlighter(JTextComponent textComponent) Instantiates a new search highlighter for the given text component.
Value<String>	searchStringValue()
void	setHighlightColor(Color color)
void	setSelectedHighlightColor(Color color)

Methods inherited from class java.lang.Object

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

Method Detail

searchStringValue

public Value<String> searchStringValue()

Returns:

the search string value

caseSensitiveState

public State caseSensitiveState()

Returns:

the state controlling whether the search is case-sensitive.

setHighlightColor

public void setHighlightColor(Color color)

Parameters:

color - the color to use when highlighting search results.

setSelectedHighlightColor

public void setSelectedHighlightColor(Color color)

Parameters:

color - the color to use when highlighting the selected search result.

createSearchField

public JTextField createSearchField()

Returns:

a text field for entering the search text.

searchHighlighter

public static SearchHighlighter searchHighlighter(JTextComponent textComponent)

Instantiates a new search highlighter for the given text component.

Parameters:

textComponent - the text component to search

Returns:

a new SearchHighlighter for the given component