jidefx.scene.control.searchable

Class TextInputControlSearchable

java.lang.Object

jidefx.scene.control.searchable.Searchable<java.lang.String>

jidefx.scene.control.searchable.TextInputControlSearchable

public class TextInputControlSearchable
extends Searchable<java.lang.String>

TextComponentSearchable is an concrete implementation of Searchable that enables the search function in TextInputControl.

It's very simple to use it. Assuming you have a TextArea, all you need to do is to call

 TextArea textArea = ....;
 TextInputControlSearchable searchable = new TextInputControlSearchable(textComponent);
 

Now the TextInputControl will have the search function.

There is very little customization you need to do to ListSearchable. The only thing you might need is when the element in the TextInputControl needs a special conversion to convert to string. If so, you can override convertElementToString() to provide you own algorithm to do the conversion.

 TextArea textArea = ....;
 TextInputControlSearchable searchable = new TextInputControlSearchable(textArea) {
      protected String convertElementToString(Object object) {
          ...
      }

      protected boolean isActivateKey(KeyEvent e) { // change to a different activation key
          return ...;
      }
 };
 

Additional customization can be done on the base Searchable class such as background and foreground color, keystrokes, case sensitivity.

Due to the special case of TextInputControl, the searching doesn't support wild card '*' or '?' as in other Searchables.

Property Summary

Properties inherited from class jidefx.scene.control.searchable.Searchable

caeSensitiveProperty, fromStartProperty, matchingElementProperty, matchingIndexProperty, popupPositionProperty, popupPositionRelativeToProperty, repeatsProperty, searchingDelayProperty, searchingLabelProperty, searchingProperty, searchingTextProperty, typedTextProperty, wildcardEnabledProperty

Nested Class Summary

Nested classes/interfaces inherited from class jidefx.scene.control.searchable.Searchable

Searchable.SearchPopup

Field Summary

Fields inherited from class jidefx.scene.control.searchable.Searchable

_boundsListener, _keyListener, _node, _visibleListener, PROPERTY_SEARCHABLE

Constructor Summary

Constructors

Constructor and Description
TextInputControlSearchable(javafx.scene.control.TextInputControl textInputControl)

Method Summary

Modifier and Type	Method and Description
protected void	addHighlight(int index, java.lang.String text, boolean incremental) Adds highlight to text component at specified index and text.
protected java.lang.String	convertElementToString(java.lang.String element) Converts the element in TextInputControl to string.
int	findFirst(java.lang.String s) Finds the first element that matches the searching text.
int	findFromCursor(java.lang.String s) Finds the next matching index from the cursor.
int	findLast(java.lang.String s) Finds the last element that matches the searching text.
int	findNext(java.lang.String s) Finds the next matching index from the cursor.
int	findPrevious(java.lang.String s) Finds the previous matching index from the cursor.
protected java.lang.String	getElementAt(int index) Gets the element at the specified index.
protected int	getElementCount() Gets the total element count in the control.
protected int	getSelectedIndex() Gets the selected index in the control.
void	hidePopup() Hides the popup.
void	installListeners() Installs necessary listeners to the control.
protected boolean	isActivateKey(javafx.scene.input.KeyEvent e) Checks if the key in KeyEvent should activate the search popup.
protected void	keyTypedOrPressed(javafx.scene.input.KeyEvent e) This method is called when a key is typed or pressed.
protected void	removeAllHighlights() Removes all highlights from the text component.
int	reverseFindFromCursor(java.lang.String s) Finds the previous matching index from the cursor.
protected void	setSelectedIndex(int index, boolean incremental) Sets the selected index.
void	showPopup(java.lang.String searchingText) Shows the search popup.
void	uninstallListeners() Uninstall the listeners that installed before.

Methods inherited from class jidefx.scene.control.searchable.Searchable

adjustSelectedIndex, caeSensitiveProperty, compare, compareAsString, createSearchPopup, findAll, fromStartProperty, getCurrentIndex, getCursor, getElementAtAsString, getHidePopupDelay, getMatchingElement, getMatchingIndex, getNode, getPopupPosition, getPopupPositionRelativeTo, getResourceString, getSearchable, getSearchingDelay, getSearchingText, getSearchLabel, getWildcardSupport, highlightAll, isCaseSensitive, isDeactivateKey, isFindFirstKey, isFindLastKey, isFindNextKey, isFindPreviousKey, isFromStart, isIncrementalSelectKey, isNavigationKey, isPopupVisible, isRepeats, isReverseOrder, isSearching, isSelectAllKey, isWildcardEnabled, matchingElementProperty, matchingIndexProperty, popupPositionProperty, popupPositionRelativeToProperty, repeatsProperty, searchingDelayProperty, searchingLabelProperty, searchingProperty, searchingTextProperty, select, setCaseSensitive, setCursor, setCursor, setFromStart, setHidePopupDelay, setMatchingElement, setMatchingIndex, setPopupPosition, setPopupPositionRelativeTo, setRepeats, setReverseOrder, setSearching, setSearchingDelay, setSearchingText, setSearchLabel, setWildcardEnabled, setWildcardSupport, typedTextProperty, wildcardEnabledProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

TextInputControlSearchable

public TextInputControlSearchable(javafx.scene.control.TextInputControl textInputControl)

Method Detail

installListeners

public void installListeners()

Description copied from class: Searchable

Installs necessary listeners to the control. This method will be called automatically when Searchable is created.

Overrides:

installListeners in class Searchable<java.lang.String>

uninstallListeners

public void uninstallListeners()

Description copied from class: Searchable

Uninstall the listeners that installed before. You can call this method if you decide to make the existing searchable control not searchable.

Overrides:

uninstallListeners in class Searchable<java.lang.String>

keyTypedOrPressed

protected void keyTypedOrPressed(javafx.scene.input.KeyEvent e)

Description copied from class: Searchable

This method is called when a key is typed or pressed.

Overrides:

keyTypedOrPressed in class Searchable<java.lang.String>

Parameters:

e - the KeyEvent.

setSelectedIndex

protected void setSelectedIndex(int index,
                                boolean incremental)

Description copied from class: Searchable

Sets the selected index. The concrete implementation should call methods on the control to select the element at the specified index. The incremental flag is used to do multiple select. If the flag is true, the element at the index should be added to current selection. If false, you should clear previous selection and then select the element.

Specified by:

setSelectedIndex in class Searchable<java.lang.String>

Parameters:

index - the index to be selected

incremental - a flag to enable multiple selection. If the flag is true, the element at the index should be added to current selection. If false, you should clear previous selection and then select the element.

addHighlight

protected void addHighlight(int index,
                            java.lang.String text,
                            boolean incremental)

Adds highlight to text component at specified index and text.

Parameters:

index - the index of the text to be highlighted

text - the text to be highlighted

incremental - if this is an incremental adding highlight

removeAllHighlights

protected void removeAllHighlights()

Removes all highlights from the text component.

getSelectedIndex

protected int getSelectedIndex()

Description copied from class: Searchable

Gets the selected index in the control. The concrete implementation should call methods on the control to retrieve the current selected index. If the control supports multiple selection, it's OK just return the index of the first selection.

Here are some examples. In the case of ListView, the index is the row index. In the case of TreeView, the index is the row index too. In the case of TableView, depending on the selection mode, the index could be row index (in row selection mode), or could be the cell index (in cell selection mode).

Specified by:

getSelectedIndex in class Searchable<java.lang.String>

Returns:

the selected index.

getElementAt

protected java.lang.String getElementAt(int index)

Description copied from class: Searchable

Gets the element at the specified index. The element could be any data structure that internally used in the control. The convertElementToString method will give you a chance to convert the element to string which is used to compare with the string that user types in.

Specified by:

getElementAt in class Searchable<java.lang.String>

Parameters:

index - the index

Returns:

the element at the specified index.

getElementCount

protected int getElementCount()

Description copied from class: Searchable

Gets the total element count in the control. Different concrete implementation could have different interpretation of the count. This is totally OK as long as it's consistent in all the methods. For example, the index parameter in other methods should be always a valid value within the total count.

Specified by:

getElementCount in class Searchable<java.lang.String>

Returns:

the total element count.

convertElementToString

protected java.lang.String convertElementToString(java.lang.String element)

Converts the element in TextInputControl to string. The returned value will be the toString() of whatever element that returned from list.getModel().getElementAt(i).

Specified by:

convertElementToString in class Searchable<java.lang.String>

Parameters:

element - the element to be converted

Returns:

the string representing the element in the TextInputControl.

isActivateKey

protected boolean isActivateKey(javafx.scene.input.KeyEvent e)

Description copied from class: Searchable

Checks if the key in KeyEvent should activate the search popup.

Overrides:

isActivateKey in class Searchable<java.lang.String>

Parameters:

e - the key event

Returns:

true if the KeyEvent is a KEY_PRESSED event and the key code is isLetterKey or isDigitKey.

findLast

public int findLast(java.lang.String s)

Description copied from class: Searchable

Finds the last element that matches the searching text.

Overrides:

findLast in class Searchable<java.lang.String>

Parameters:

s - the searching text

Returns:

the last element that matches the searching text.

findFirst

public int findFirst(java.lang.String s)

Description copied from class: Searchable

Finds the first element that matches the searching text.

Overrides:

findFirst in class Searchable<java.lang.String>

Parameters:

s - the searching text

Returns:

the first element that matches with the searching text.

findFromCursor

public int findFromCursor(java.lang.String s)

Description copied from class: Searchable

Finds the next matching index from the cursor. If it reaches the end, it will restart from the beginning. However is the reverseOrder flag is true, it will finds the previous matching index from the cursor. If it reaches the beginning, it will restart from the end.

Overrides:

findFromCursor in class Searchable<java.lang.String>

Parameters:

s - the searching text

Returns:

the next index that the element matches the searching text.

reverseFindFromCursor

public int reverseFindFromCursor(java.lang.String s)

Description copied from class: Searchable

Finds the previous matching index from the cursor. If it reaches the beginning, it will restart from the end.

Overrides:

reverseFindFromCursor in class Searchable<java.lang.String>

Parameters:

s - the searching text

Returns:

the next index that the element matches the searching text.

findNext

public int findNext(java.lang.String s)

Description copied from class: Searchable

Finds the next matching index from the cursor.

Overrides:

findNext in class Searchable<java.lang.String>

Parameters:

s - the searching text

Returns:

the next index that the element matches the searching text.

findPrevious

public int findPrevious(java.lang.String s)

Description copied from class: Searchable

Finds the previous matching index from the cursor.

Overrides:

findPrevious in class Searchable<java.lang.String>

Parameters:

s - the searching text

Returns:

the previous index that the element matches the searching text.

showPopup

public void showPopup(java.lang.String searchingText)

Description copied from class: Searchable

Shows the search popup. By default, the search popup will be visible automatically when user types in the first key (in the case of ListView, TreeView, TableView, ComboBox, ChoiceBox) or types in designated keystroke (in the case of editable TextInputControl). So this method is only used when you want to show the popup manually.

Overrides:

showPopup in class Searchable<java.lang.String>

Parameters:

searchingText - the searching text

hidePopup

public void hidePopup()

Description copied from class: Searchable

Hides the popup.

Overrides:

hidePopup in class Searchable<java.lang.String>