Searchable (module-common 0.9.1 API)

java.lang.Object
- jidefx.scene.control.searchable.Searchable<T>

Type Parameters:

T - the element type in the control.

Direct Known Subclasses:

ChoiceBoxSearchable, ComboBoxSearchable, ListViewSearchable, TableViewSearchable, TextInputControlSearchable, TreeViewSearchable
```
public abstract class Searchable<T>
extends java.lang.Object
```
In JavaFX, ListView, TableView, TreeView, ComboBox, ChoiceBox, TextArea are six data-rich controls. They can be used to display a huge amount of data so a convenient searching feature is essential in those controls.
The Searchable feature is to that user can type a character, the control will find the first entry that matches with the character. Searchable is such a class that makes it possible. An end user can simply type any string they want to search for and use arrow keys to navigate to the next or previous occurrence. See below for the list of controls that support searchable.
The main purpose of searchable is to make the searching for a particular string easier in a control having a lot of information. All features are related to how to make it quicker and easier to identify the matching text.
Navigation feature - After user types in a text and presses the up or down arrow keys, only items that match with the typed text will be selected. User can press the up and down keys to quickly look at what those items are. In addition, end users can use the home key in order to navigate to the first occurrence. Likewise, the end key will navigate to the last occurrence. The navigation keys are fully customizable. The next section will explain how to customize them.
Multiple selection feature - If you press and hold CTRL key while pressing up and down arrow, it will find next/previous occurrence while keeping existing selections. See the screenshot below. This way one can easily find several occurrences and apply an action to all of them later.
Select all feature ? Further extending the multiple selections feature, you can even select all. If you type in a searching text and press CTRL+A, all the occurrences matching the searching text will be selected. This is a very handy feature. For example, you want to delete all rows in a table whose "name" column begins with "old". You can type in "old" and press CTRL+A, now all rows beginning with "old" will be selected. If you hook up delete key with the table, pressing delete key will delete all selected rows. Imagine without this searchable feature, users will have to hold CTRL key, look through each row, and click on the row they want to delete. In case they forgot to hold tight the CTRL key while clicking, they have to start over again.
Basic regular expression support - It allows '?' to match any character and '*' to match any number of characters. For example "a*c" will match "ac", "abc", "abbbc", or even "a b c" etc. "a?c" will only match "abc" or "a c".
Recursive search (only in TreeViewSearchable) ? In the case of TreeSearchable, there is an option called recursive. You can call TreeViewSearchable#setRecursive(true/false) to change it. If TreeViewSearchable is recursive, it will search all tree nodes including those, which are not visible to find the matching node. Obviously, if your tree has unlimited number of tree nodes or a potential huge number of tree nodes (such as a tree to represent file system), the recursive attribute should be false. To avoid this potential problem in this case, we default it to false.
Popup position ? the search popup position can be customized using setPopupPosition method using the JavaFX Pos. We currently only support TOP_XXX and BOTTOM_XXX total six positions. Furthermore, you can use setPopupPositionRelativeTo method to specify a Node which will be used to determine which Node the Pos is relative to.
Please refer to the JideFX Common Layer Developer Guide for more information.

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.BooleanProperty`	`caeSensitive`
`javafx.beans.property.BooleanProperty`	`fromStart`
`javafx.beans.property.ObjectProperty<T>`	`matchingElement`
`javafx.beans.property.IntegerProperty`	`matchingIndex`
`javafx.beans.property.ObjectProperty<javafx.geometry.Pos>`	`popupPosition`
`javafx.beans.property.ObjectProperty<javafx.scene.Node>`	`popupPositionRelativeTo`
`javafx.beans.property.BooleanProperty`	`repeats`
`javafx.beans.property.ObjectProperty<javafx.util.Duration>`	`searchingDelay`
`javafx.beans.property.StringProperty`	`searchingLabel`
`javafx.beans.property.BooleanProperty`	`searching`
`javafx.beans.property.StringProperty`	`searchingText`
`javafx.beans.property.StringProperty`	`typedText`
`javafx.beans.property.BooleanProperty`	`wildcardEnabled`

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class Searchable.SearchPopup

Nested Classes
Modifier and Type	Class and Description
`protected class`	`Searchable.SearchPopup`

Field Summary

Fields
Modifier and Type	Field and Description
`protected javafx.beans.value.ChangeListener<javafx.geometry.Bounds>`	`_boundsListener`
`protected javafx.event.EventHandler<javafx.scene.input.KeyEvent>`	`_keyListener`
`protected javafx.scene.Node`	`_node`
`protected javafx.beans.value.ChangeListener<java.lang.Boolean>`	`_visibleListener`
`static java.lang.String`	`PROPERTY_SEARCHABLE` The client property for Searchable instance.

Constructor Summary

Constructors
Constructor and Description

Searchable(javafx.scene.Node node)
Creates a Searchable.

Constructors
Constructor and Description
`Searchable(javafx.scene.Node node)` Creates a Searchable.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`adjustSelectedIndex(int index, boolean incremental)` Sets the selected index.
`javafx.beans.property.BooleanProperty`	`caeSensitiveProperty()`
`protected boolean`	`compare(T element, java.lang.String searchingText)` Checks if the element matches the searching text.
`protected boolean`	`compareAsString(java.lang.String text, java.lang.String searchingText)` Checks if the element string matches the searching text.
`protected abstract java.lang.String`	`convertElementToString(T element)` Converts the element that returns from getElementAt() to string.
`protected Searchable.SearchPopup`	`createSearchPopup()` Creates the popup to hold the searching text.
`java.util.List<java.lang.Integer>`	`findAll(java.lang.String s)` `findAll` uses the Searchable to find all the element indices that match the searching 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.
`javafx.beans.property.BooleanProperty`	`fromStartProperty()`
`protected int`	`getCurrentIndex()`
`int`	`getCursor()` Gets the cursor which is the index of current location when searching.
`protected abstract T`	`getElementAt(int index)` Gets the element at the specified index.
`java.lang.String`	`getElementAtAsString(int index)` Gets the element at the specified index as string using `convertElementToString(Object)` method.
`protected abstract int`	`getElementCount()` Gets the total element count in the control.
`javafx.util.Duration`	`getHidePopupDelay()` Gets the duration before hiding the popup.
`T`	`getMatchingElement()` Gets the value of the property matchingElement.
`int`	`getMatchingIndex()` Gets the value of the property matchingIndex.
`javafx.scene.Node`	`getNode()` Gets the actual node which installed this Searchable.
`javafx.geometry.Pos`	`getPopupPosition()` Gets the popup position.
`javafx.scene.Node`	`getPopupPositionRelativeTo()` Gets the node that the position of the popup relative to.
`protected java.lang.String`	`getResourceString(java.lang.String key)` Gets the localized string from resource bundle.
`static Searchable`	`getSearchable(javafx.scene.Node node)` Gets the Searchable installed on the node.
`javafx.util.Duration`	`getSearchingDelay()` If it returns a positive number, it will wait for that many ms before doing the search.
`java.lang.String`	`getSearchingText()` Gets the value of the property searchingText.
`java.lang.String`	`getSearchLabel()` Gets the current text that appears in the search popup.
`protected abstract int`	`getSelectedIndex()` Gets the selected index in the control.
`WildcardSupport`	`getWildcardSupport()` Gets the WildcardSupport.
`void`	`hidePopup()` Hides the popup.
`protected void`	`highlightAll()` Highlight all matching cases in the target.
`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.
`boolean`	`isCaseSensitive()` Checks if the case is sensitive during searching.
`protected boolean`	`isDeactivateKey(javafx.scene.input.KeyEvent e)` Checks if the key in KeyEvent should hide the search popup.
`protected boolean`	`isFindFirstKey(javafx.scene.input.KeyEvent e)` Checks if the key is used as a key to find the first occurrence.
`protected boolean`	`isFindLastKey(javafx.scene.input.KeyEvent e)` Checks if the key is used as a key to find the last occurrence.
`protected boolean`	`isFindNextKey(javafx.scene.input.KeyEvent e)` Checks if the key is used as a key to find the next occurrence.
`protected boolean`	`isFindPreviousKey(javafx.scene.input.KeyEvent e)` Checks if the key is used as a key to find the previous occurrence.
`boolean`	`isFromStart()` This is a property of how to compare searching text with the data.
`protected boolean`	`isIncrementalSelectKey(javafx.scene.input.KeyEvent e)` Checks if the key will trigger incremental selection.
`protected boolean`	`isNavigationKey(javafx.scene.input.KeyEvent e)` Checks if the key is used as a navigation key.
`boolean`	`isPopupVisible()` Check if the searchable popup is visible.
`boolean`	`isRepeats()` Checks if restart from the beginning when searching reaches the end or restart from the end when reaches beginning.
`boolean`	`isReverseOrder()` Checks the searching order.
`boolean`	`isSearching()` Gets the value of the property searching.
`protected boolean`	`isSelectAllKey(javafx.scene.input.KeyEvent e)` Checks if the key will trigger selecting all.
`boolean`	`isWildcardEnabled()` Checks if it supports wildcard in searching text.
`protected void`	`keyTypedOrPressed(javafx.scene.input.KeyEvent e)` This method is called when a key is typed or pressed.
`javafx.beans.property.ObjectProperty<T>`	`matchingElementProperty()`
`javafx.beans.property.IntegerProperty`	`matchingIndexProperty()`
`javafx.beans.property.ObjectProperty<javafx.geometry.Pos>`	`popupPositionProperty()`
`javafx.beans.property.ObjectProperty<javafx.scene.Node>`	`popupPositionRelativeToProperty()`
`javafx.beans.property.BooleanProperty`	`repeatsProperty()`
`int`	`reverseFindFromCursor(java.lang.String s)` Finds the previous matching index from the cursor.
`javafx.beans.property.ObjectProperty<javafx.util.Duration>`	`searchingDelayProperty()`
`javafx.beans.property.StringProperty`	`searchingLabelProperty()`
`javafx.beans.property.BooleanProperty`	`searchingProperty()`
`javafx.beans.property.StringProperty`	`searchingTextProperty()`
`protected void`	`select(int index)` Select the index for the searching text.
`void`	`setCaseSensitive(boolean caseSensitive)` Sets the case sensitive flag.
`void`	`setCursor(int cursor)` Sets the cursor which is the index of current location when searching.
`void`	`setCursor(int cursor, boolean incremental)` Sets the cursor which is the index of current location when searching.
`void`	`setFromStart(boolean fromStart)` Sets the fromStart property.
`void`	`setHidePopupDelay(javafx.util.Duration hidePopupDelay)` Sets the delay before hiding the popup.
`void`	`setMatchingElement(T matchingElement)` Sets the value of the property matchingElement.
`void`	`setMatchingIndex(int matchingIndex)` Sets the value of the property matchingIndex.
`void`	`setPopupPosition(javafx.geometry.Pos popupPosition)` Sets the popup position.
`void`	`setPopupPositionRelativeTo(javafx.scene.Node popupPositionRelativeTo)` Sets the position of the popup relative to the specified node.
`void`	`setRepeats(boolean repeats)` Sets the repeat flag.
`void`	`setReverseOrder(boolean reverseOrder)` Sets the searching order.
`void`	`setSearching(boolean searching)` Sets the value of the property searching.
`void`	`setSearchingDelay(javafx.util.Duration searchingDelay)` If this flag is set to Duration, it will wait for that many ms before doing the search.
`void`	`setSearchingText(java.lang.String searchingText)` Sets the value of the property searchingText.
`void`	`setSearchLabel(java.lang.String searchLabel)` Sets the text that appears in the search popup.
`protected abstract void`	`setSelectedIndex(int index, boolean incremental)` Sets the selected index.
`void`	`setWildcardEnabled(java.lang.Boolean wildcardEnabled)` Enable or disable the usage of wildcard.
`void`	`setWildcardSupport(WildcardSupport wildcardSupport)` Sets the WildcardSupport.
`void`	`showPopup(java.lang.String searchingText)` Shows the search popup.
`javafx.beans.property.StringProperty`	`typedTextProperty()`
`void`	`uninstallListeners()` Uninstall the listeners that installed before.
`javafx.beans.property.BooleanProperty`	`wildcardEnabledProperty()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - caeSensitive
```
public javafx.beans.property.BooleanProperty caeSensitiveProperty
```
  - searchingDelay
```
public javafx.beans.property.ObjectProperty<javafx.util.Duration> searchingDelayProperty
```
    See Also:
    
    getSearchingDelay(), setSearchingDelay(Duration)
  - repeats
```
public javafx.beans.property.BooleanProperty repeatsProperty
```
    See Also:
    
    isRepeats(), setRepeats(boolean)
  - wildcardEnabled
```
public javafx.beans.property.BooleanProperty wildcardEnabledProperty
```
    See Also:
    
    isWildcardEnabled(), setWildcardEnabled(Boolean)
  - searchingLabel
```
public javafx.beans.property.StringProperty searchingLabelProperty
```
  - popupPosition
```
public javafx.beans.property.ObjectProperty<javafx.geometry.Pos> popupPositionProperty
```
    See Also:
    
    getPopupPosition(), setPopupPosition(Pos)
  - popupPositionRelativeTo
```
public javafx.beans.property.ObjectProperty<javafx.scene.Node> popupPositionRelativeToProperty
```
    See Also:
    
    getPopupPositionRelativeTo(), setPopupPositionRelativeTo(Node)
  - searchingText
```
public javafx.beans.property.StringProperty searchingTextProperty
```
    See Also:
    
    getSearchingText(), setSearchingText(String)
  - typedText
```
public javafx.beans.property.StringProperty typedTextProperty
```
  - searching
```
public javafx.beans.property.BooleanProperty searchingProperty
```
    See Also:
    
    isSearching(), setSearching(boolean)
  - matchingIndex
```
public javafx.beans.property.IntegerProperty matchingIndexProperty
```
    See Also:
    
    getMatchingIndex(), setMatchingIndex(int)
  - matchingElement
```
public javafx.beans.property.ObjectProperty<T> matchingElementProperty
```
    See Also:
    
    getMatchingElement(), setMatchingElement(T)
  - fromStart
```
public javafx.beans.property.BooleanProperty fromStartProperty
```
    See Also:
    
    isFromStart(), setFromStart(boolean)
- Field Detail
  - _node
```
protected final javafx.scene.Node _node
```
  - _visibleListener
```
protected javafx.beans.value.ChangeListener<java.lang.Boolean> _visibleListener
```
  - _boundsListener
```
protected javafx.beans.value.ChangeListener<javafx.geometry.Bounds> _boundsListener
```
  - _keyListener
```
protected javafx.event.EventHandler<javafx.scene.input.KeyEvent> _keyListener
```
  - PROPERTY_SEARCHABLE
```
public static final java.lang.String PROPERTY_SEARCHABLE
```
    The client property for Searchable instance. When Searchable is installed on a control, this client property has the Searchable.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Searchable
```
public Searchable(javafx.scene.Node node)
```
    Creates a Searchable.
    
    Parameters:
    
    node - node where the Searchable will be installed.
- Method Detail
  - getSelectedIndex
```
protected abstract int getSelectedIndex()
```
    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).
    
    Returns:
    
    the selected index.
  - setSelectedIndex
```
protected abstract void setSelectedIndex(int index,
                                         boolean incremental)
```
    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.
    
    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.
  - adjustSelectedIndex
```
public void adjustSelectedIndex(int index,
                                boolean incremental)
```
    Sets the selected index. The reason we have this method is just for back compatibility. All the method do is just to invoke setSelectedIndex(int, boolean).
    Please do NOT try to override this method. Always override setSelectedIndex(int, boolean) instead.
    
    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.
  - getElementCount
```
protected abstract int getElementCount()
```
    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.
    
    Returns:
    
    the total element count.
  - getElementAt
```
protected abstract T getElementAt(int index)
```
    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.
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the element at the specified index.
  - convertElementToString
```
protected abstract java.lang.String convertElementToString(T element)
```
    Converts the element that returns from getElementAt() to string.
    
    Parameters:
    
    element - the element to be converted
    
    Returns:
    
    the string representing the element in the control.
  - hidePopup
```
public void hidePopup()
```
    Hides the popup.
  - installListeners
```
public void installListeners()
```
    Installs necessary listeners to the control. This method will be called automatically when Searchable is created.
  - uninstallListeners
```
public void uninstallListeners()
```
    Uninstall the listeners that installed before. You can call this method if you decide to make the existing searchable control not searchable.
  - compare
```
protected boolean compare(T element,
                          java.lang.String searchingText)
```
    Checks if the element matches the searching text.
    
    Parameters:
    
    element - the element to be checked
    
    searchingText - the searching text
    
    Returns:
    
    true if matches.
  - compareAsString
```
protected boolean compareAsString(java.lang.String text,
                                  java.lang.String searchingText)
```
    Checks if the element string matches the searching text. Different from compare(Object, String), this method is after the element has been converted to string using convertElementToString(Object).
    
    Parameters:
    
    text - the text to be checked
    
    searchingText - the searching text
    
    Returns:
    
    true if matches.
  - getCursor
```
public int getCursor()
```
    Gets the cursor which is the index of current location when searching. The value will be used in findNext and findPrevious.
    
    Returns:
    
    the current position of the cursor.
  - setCursor
```
public void setCursor(int cursor)
```
    Sets the cursor which is the index of current location when searching. The value will be used in findNext and findPrevious.
    
    Parameters:
    
    cursor - the new position of the cursor.
  - setCursor
```
public void setCursor(int cursor,
                      boolean incremental)
```
    Sets the cursor which is the index of current location when searching. The value will be used in findNext and findPrevious. We will call this method automatically inside this class. However, if you ever call setSelectedIndex(int, boolean) method from your code, you should call this method with the same parameters.
    
    Parameters:
    
    cursor - the new position of the cursor.
    
    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.
  - highlightAll
```
protected void highlightAll()
```
    Highlight all matching cases in the target.
    In default implementation, it will just search all texts in the target to highlight all. If you have a really huge text to search, you may want to override this method to have a lazy behavior on visible areas only.
  - select
```
protected void select(int index)
```
    Select the index for the searching text.
    
    Parameters:
    
    index - the start offset
  - findNext
```
public int findNext(java.lang.String s)
```
    Finds the next matching index from the cursor.
    
    Parameters:
    
    s - the searching text
    
    Returns:
    
    the next index that the element matches the searching text.
  - getCurrentIndex
```
protected int getCurrentIndex()
```
  - findPrevious
```
public int findPrevious(java.lang.String s)
```
    Finds the previous matching index from the cursor.
    
    Parameters:
    
    s - the searching text
    
    Returns:
    
    the previous index that the element matches the searching text.
  - findFromCursor
```
public int findFromCursor(java.lang.String s)
```
    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.
    
    Parameters:
    
    s - the searching text
    
    Returns:
    
    the next index that the element matches the searching text.
  - reverseFindFromCursor
```
public int reverseFindFromCursor(java.lang.String s)
```
    Finds the previous matching index from the cursor. If it reaches the beginning, it will restart from the end.
    
    Parameters:
    
    s - the searching text
    
    Returns:
    
    the next index that the element matches the searching text.
  - findFirst
```
public int findFirst(java.lang.String s)
```
    Finds the first element that matches the searching text.
    
    Parameters:
    
    s - the searching text
    
    Returns:
    
    the first element that matches with the searching text.
  - findLast
```
public int findLast(java.lang.String s)
```
    Finds the last element that matches the searching text.
    
    Parameters:
    
    s - the searching text
    
    Returns:
    
    the last element that matches the searching text.
  - keyTypedOrPressed
```
protected void keyTypedOrPressed(javafx.scene.input.KeyEvent e)
```
    This method is called when a key is typed or pressed.
    
    Parameters:
    
    e - the KeyEvent.
  - showPopup
```
public void showPopup(java.lang.String searchingText)
```
    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.
    
    Parameters:
    
    searchingText - the searching text
  - createSearchPopup
```
protected Searchable.SearchPopup createSearchPopup()
```
    Creates the popup to hold the searching text.
    
    Returns:
    
    the searching popup.
  - isFindFirstKey
```
protected boolean isFindFirstKey(javafx.scene.input.KeyEvent e)
```
    Checks if the key is used as a key to find the first occurrence.
    
    Parameters:
    
    e - the key event
    
    Returns:
    
    true if the key in KeyEvent is a key to find the first occurrence. By default, home key is used.
  - isFindLastKey
```
protected boolean isFindLastKey(javafx.scene.input.KeyEvent e)
```
    Checks if the key is used as a key to find the last occurrence.
    
    Parameters:
    
    e - the key event
    
    Returns:
    
    true if the key in KeyEvent is a key to find the last occurrence. By default, end key is used.
  - isFindPreviousKey
```
protected boolean isFindPreviousKey(javafx.scene.input.KeyEvent e)
```
    Checks if the key is used as a key to find the previous occurrence.
    
    Parameters:
    
    e - the key event
    
    Returns:
    
    true if the key in KeyEvent is a key to find the previous occurrence. By default, up arrow key is used.
  - isFindNextKey
```
protected boolean isFindNextKey(javafx.scene.input.KeyEvent e)
```
    Checks if the key is used as a key to find the next occurrence.
    
    Parameters:
    
    e - the key event
    
    Returns:
    
    true if the key in KeyEvent is a key to find the next occurrence. By default, down arrow key is used.
  - isNavigationKey
```
protected boolean isNavigationKey(javafx.scene.input.KeyEvent e)
```
    Checks if the key is used as a navigation key. Navigation keys are keys which are used to navigate to other occurrences of the searching string.
    
    Parameters:
    
    e - the key event
    
    Returns:
    
    true if the key in KeyEvent is a navigation key.
  - isActivateKey
```
protected boolean isActivateKey(javafx.scene.input.KeyEvent e)
```
    Checks if the key in KeyEvent should activate the search popup.
    
    Parameters:
    
    e - the key event
    
    Returns:
    
    true if the KeyEvent is a KEY_PRESSED event and the key code is isLetterKey or isDigitKey.
  - isDeactivateKey
```
protected boolean isDeactivateKey(javafx.scene.input.KeyEvent e)
```
    Checks if the key in KeyEvent should hide the search popup. If this method return true and the key is not used for navigation purpose (isNavigationKey(KeyEvent) return false), the popup will be hidden.
    
    Parameters:
    
    e - the key event
    
    Returns:
    
    true if the keyCode in the KeyEvent is escape key, enter key, or any of the arrow keys such as page up, page down, home, end, left, right, up and down.
  - isSelectAllKey
```
protected boolean isSelectAllKey(javafx.scene.input.KeyEvent e)
```
    Checks if the key will trigger selecting all.
    
    Parameters:
    
    e - the key event
    
    Returns:
    
    true if the key in KeyEvent is a key to trigger selecting all.
  - isIncrementalSelectKey
```
protected boolean isIncrementalSelectKey(javafx.scene.input.KeyEvent e)
```
    Checks if the key will trigger incremental selection.
    
    Parameters:
    
    e - the key event
    
    Returns:
    
    true if the key in KeyEvent is a key to trigger incremental selection. By default, ctrl down key is used.
  - caeSensitiveProperty
```
public javafx.beans.property.BooleanProperty caeSensitiveProperty()
```
  - isCaseSensitive
```
public boolean isCaseSensitive()
```
    Checks if the case is sensitive during searching.
    
    Returns:
    
    true if the searching is case sensitive.
  - setCaseSensitive
```
public void setCaseSensitive(boolean caseSensitive)
```
    Sets the case sensitive flag. By default, it's false meaning it's a case insensitive search.
    
    Parameters:
    
    caseSensitive - the flag if searching is case sensitive
  - searchingDelayProperty
```
public javafx.beans.property.ObjectProperty<javafx.util.Duration> searchingDelayProperty()
```
    See Also:
    
    getSearchingDelay(), setSearchingDelay(Duration)
  - getSearchingDelay
```
public javafx.util.Duration getSearchingDelay()
```
    If it returns a positive number, it will wait for that many ms before doing the search. When the searching is complex, this flag will be useful to make the searching efficient. In the other words, if user types in several keys very quickly, there will be only one search. If it returns Duration.ZERO, each key will generate a search.
    
    Returns:
    
    the delay before searching starts.
  - setSearchingDelay
```
public void setSearchingDelay(javafx.util.Duration searchingDelay)
```
    If this flag is set to Duration, it will wait for that many ms before doing the search. When the searching is complex, this flag will be useful to make the searching efficient. In the other words, if user types in several keys very quickly, there will be only one search. If this flag is set to Duration.ZERO, each key will generate a search with no delay.
    
    Parameters:
    
    searchingDelay - the delay before searching start.
  - repeatsProperty
```
public javafx.beans.property.BooleanProperty repeatsProperty()
```
    See Also:
    
    isRepeats(), setRepeats(boolean)
  - isRepeats
```
public boolean isRepeats()
```
    Checks if restart from the beginning when searching reaches the end or restart from the end when reaches beginning. Default is false.
    
    Returns:
    
    true or false.
  - setRepeats
```
public void setRepeats(boolean repeats)
```
    Sets the repeat flag. By default, it's false meaning it will stop searching when reaching the end or reaching the beginning.
    
    Parameters:
    
    repeats - the repeat flag
  - wildcardEnabledProperty
```
public javafx.beans.property.BooleanProperty wildcardEnabledProperty()
```
    See Also:
    
    isWildcardEnabled(), setWildcardEnabled(Boolean)
  - isWildcardEnabled
```
public boolean isWildcardEnabled()
```
    Checks if it supports wildcard in searching text. By default it is true which means user can type in "*" or "?" to match with any characters or any character. If it's false, it will treat "*" or "?" as a regular character.
    
    Returns:
    
    true if it supports wildcard.
  - setWildcardEnabled
```
public void setWildcardEnabled(java.lang.Boolean wildcardEnabled)
```
    Enable or disable the usage of wildcard.
    
    Parameters:
    
    wildcardEnabled - the flag if wildcard is enabled
    
    See Also:
    
    isWildcardEnabled()
  - getWildcardSupport
```
public WildcardSupport getWildcardSupport()
```
    Gets the WildcardSupport. If user never sets it, WildcardSupport will be used.
    
    Returns:
    
    the WildcardSupport.
  - setWildcardSupport
```
public void setWildcardSupport(WildcardSupport wildcardSupport)
```
    Sets the WildcardSupport. This class allows you to define what wildcards to use and how to convert the wildcard strings to a regular expression string which is eventually used to search.
    
    Parameters:
    
    wildcardSupport - the new WildCardSupport.
  - searchingLabelProperty
```
public javafx.beans.property.StringProperty searchingLabelProperty()
```
  - getSearchLabel
```
public java.lang.String getSearchLabel()
```
    Gets the current text that appears in the search popup. By default it is "Search for: ".
    
    Returns:
    
    the text that appears in the search popup.
  - setSearchLabel
```
public void setSearchLabel(java.lang.String searchLabel)
```
    Sets the text that appears in the search popup.
    
    Parameters:
    
    searchLabel - the search label
  - getNode
```
public javafx.scene.Node getNode()
```
    Gets the actual node which installed this Searchable.
    
    Returns:
    
    the actual node which installed this Searchable.
  - popupPositionProperty
```
public javafx.beans.property.ObjectProperty<javafx.geometry.Pos> popupPositionProperty()
```
    See Also:
    
    getPopupPosition(), setPopupPosition(Pos)
  - getPopupPosition
```
public javafx.geometry.Pos getPopupPosition()
```
    Gets the popup position. The valid values are defined in <code>Pos</code>. We currently only support TOP_XXX and BOTTOM_XXX total six positions.
    
    Returns:
    
    the popup position.
  - setPopupPosition
```
public void setPopupPosition(javafx.geometry.Pos popupPosition)
```
    Sets the popup position.
    
    Parameters:
    
    popupPosition - the popup location. The valid values are defined in <code>Pos</code>. We currently only support TOP_XXX and BOTTOM_XXX total six positions.
  - popupPositionRelativeToProperty
```
public javafx.beans.property.ObjectProperty<javafx.scene.Node> popupPositionRelativeToProperty()
```
    See Also:
    
    getPopupPositionRelativeTo(), setPopupPositionRelativeTo(Node)
  - getPopupPositionRelativeTo
```
public javafx.scene.Node getPopupPositionRelativeTo()
```
    Gets the node that the position of the popup relative to.
    
    Returns:
    
    the control that the position of the popup relative to.
  - setPopupPositionRelativeTo
```
public void setPopupPositionRelativeTo(javafx.scene.Node popupPositionRelativeTo)
```
    Sets the position of the popup relative to the specified node. Then based on the value of getPopupPosition(). If you never set, we will use the searchable node or its scroll pane (if exists) as the popupPositionRelativeTo Node.
    
    Parameters:
    
    popupPositionRelativeTo - the relative node
  - searchingTextProperty
```
public javafx.beans.property.StringProperty searchingTextProperty()
```
    See Also:
    
    getSearchingText(), setSearchingText(String)
  - getSearchingText
```
public java.lang.String getSearchingText()
```
    Gets the value of the property searchingText.
  - setSearchingText
```
public void setSearchingText(java.lang.String searchingText)
```
    Sets the value of the property searchingText.
  - typedTextProperty
```
public javafx.beans.property.StringProperty typedTextProperty()
```
  - searchingProperty
```
public javafx.beans.property.BooleanProperty searchingProperty()
```
    See Also:
    
    isSearching(), setSearching(boolean)
  - isSearching
```
public boolean isSearching()
```
    Gets the value of the property searching.
  - setSearching
```
public void setSearching(boolean searching)
```
    Sets the value of the property searching.
  - matchingIndexProperty
```
public javafx.beans.property.IntegerProperty matchingIndexProperty()
```
    See Also:
    
    getMatchingIndex(), setMatchingIndex(int)
  - getMatchingIndex
```
public int getMatchingIndex()
```
    Gets the value of the property matchingIndex.
  - setMatchingIndex
```
public void setMatchingIndex(int matchingIndex)
```
    Sets the value of the property matchingIndex.
  - matchingElementProperty
```
public javafx.beans.property.ObjectProperty<T> matchingElementProperty()
```
    See Also:
    
    getMatchingElement(), setMatchingElement(T)
  - getMatchingElement
```
public T getMatchingElement()
```
    Gets the value of the property matchingElement.
  - setMatchingElement
```
public void setMatchingElement(T matchingElement)
```
    Sets the value of the property matchingElement.
  - isReverseOrder
```
public boolean isReverseOrder()
```
    Checks the searching order. By default the searchable starts searching from top to bottom. If this flag is false, it searches from bottom to top.
    
    Returns:
    
    the reverseOrder flag.
  - setReverseOrder
```
public void setReverseOrder(boolean reverseOrder)
```
    Sets the searching order. By default the searchable starts searching from top to bottom. If this flag is false, it searches from bottom to top.
    
    Parameters:
    
    reverseOrder - the flag if searching from top to bottom or from bottom to top
  - getResourceString
```
protected java.lang.String getResourceString(java.lang.String key)
```
    Gets the localized string from resource bundle. Subclass can override it to provide its own string. Available keys are defined in swing.properties that begin with "Searchable.".
    
    Parameters:
    
    key - the resource string key
    
    Returns:
    
    the localized string.
  - isPopupVisible
```
public boolean isPopupVisible()
```
    Check if the searchable popup is visible.
    
    Returns:
    
    true if visible. Otherwise, false.
  - fromStartProperty
```
public javafx.beans.property.BooleanProperty fromStartProperty()
```
    See Also:
    
    isFromStart(), setFromStart(boolean)
  - isFromStart
```
public boolean isFromStart()
```
    This is a property of how to compare searching text with the data. If it is true, it will use String.startsWith(String) to do the comparison. Otherwise, it will use String.indexOf(String) to do the comparison.
    
    Returns:
    
    true or false.
  - setFromStart
```
public void setFromStart(boolean fromStart)
```
    Sets the fromStart property.
    
    Parameters:
    
    fromStart - true if the comparison matches from the start of the text only. Otherwise false. The difference is if true, it will use String's startWith method to match. If false, it will use contains method.
  - getSearchable
```
public static Searchable getSearchable(javafx.scene.Node node)
```
    Gets the Searchable installed on the node. Null is no Searchable was installed.
    
    Parameters:
    
    node - the node
    
    Returns:
    
    the Searchable installed. Null is no Searchable was installed.
  - getHidePopupDelay
```
public javafx.util.Duration getHidePopupDelay()
```
    Gets the duration before hiding the popup.
    
    Returns:
    
    the popup timeout.
    
    See Also:
    
    setHidePopupDelay(Duration)
  - setHidePopupDelay
```
public void setHidePopupDelay(javafx.util.Duration hidePopupDelay)
```
    Sets the delay before hiding the popup.
    By default, the delay value is Duration.INDEFINITE, which means the hide popup will not be hidden unless users press ESCAPE key. You could set it to a positive value to automatically hide the search popup after an idle time.
    
    Parameters:
    
    hidePopupDelay - the delay in Duration
  - findAll
```
public java.util.List<java.lang.Integer> findAll(java.lang.String s)
```
    findAll uses the Searchable to find all the element indices that match the searching string.
    
    Parameters:
    
    s - the searching string.
    
    Returns:
    
    the list of indices.
  - getElementAtAsString
```
public java.lang.String getElementAtAsString(int index)
```
    Gets the element at the specified index as string using convertElementToString(Object) method.
    
    Parameters:
    
    index - the index.
    
    Returns:
    
    the element at the index converted to string.

Class Searchable<T>

Property Summary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

caeSensitive

searchingDelay

repeats

wildcardEnabled

searchingLabel

popupPosition

popupPositionRelativeTo

searchingText

typedText

searching

matchingIndex

matchingElement

fromStart

Field Detail

_node

_visibleListener

_boundsListener

_keyListener

PROPERTY_SEARCHABLE

Constructor Detail

Searchable

Method Detail

getSelectedIndex

setSelectedIndex

adjustSelectedIndex

getElementCount

getElementAt

convertElementToString

hidePopup

installListeners

uninstallListeners

compare

compareAsString

getCursor

setCursor

setCursor

highlightAll

select

findNext

getCurrentIndex

findPrevious

findFromCursor

reverseFindFromCursor

findFirst

findLast

keyTypedOrPressed

showPopup

createSearchPopup

isFindFirstKey

isFindLastKey

isFindPreviousKey

isFindNextKey

isNavigationKey

isActivateKey

isDeactivateKey

isSelectAllKey

isIncrementalSelectKey

caeSensitiveProperty

isCaseSensitive

setCaseSensitive

searchingDelayProperty

getSearchingDelay

setSearchingDelay

repeatsProperty

isRepeats

setRepeats

wildcardEnabledProperty

isWildcardEnabled

setWildcardEnabled

getWildcardSupport

setWildcardSupport

searchingLabelProperty