jidefx.scene.control.searchable

Class TreeViewSearchable<T>

java.lang.Object

jidefx.scene.control.searchable.Searchable<javafx.scene.control.TreeItem<T>>

jidefx.scene.control.searchable.TreeViewSearchable<T>

Type Parameters:

T - the element type in the TreeView.

public class TreeViewSearchable<T>
extends Searchable<javafx.scene.control.TreeItem<T>>

TreeViewSearchable is an concrete implementation of Searchable that enables the search function in TreeView.

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

 TreeView tree = ....;
 TreeViewSearchable searchable = new TreeViewSearchable(tree);
 

Now the TreeView will have the search function.

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

 TreeView tree = ....;
 TreeViewSearchable searchable = new TreeViewSearchable(tree) {
      protected String convertElementToString(Object object) {
          ...
      }
 };
 

The other customization you might want to is to call setRecursive(boolean) to true. It is false by default. If setting it true, we will automatically expand the TreeItem to look for the string to be searched. If your TreeView has a huge number or unlimited number of rows when fully expanded, please do not set it to true as it will for sure run out of memory.

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

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	recursive

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
TreeViewSearchable(javafx.scene.control.TreeView<T> treeView)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	convertElementToString(javafx.scene.control.TreeItem<T> object) Converts the element in TreeView to string.
protected javafx.scene.control.TreeItem<T>	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.
protected java.util.List<javafx.scene.control.TreeItem>	getTreeItems() Gets the cached tree paths list.
void	installListeners() Installs necessary listeners to the control.
boolean	isRecursive() Checks if the searchable is recursive.
protected void	populateTreePaths() Recursively go through the tree to populate the tree paths into a list and cache them.
javafx.beans.property.BooleanProperty	recursiveProperty()
protected void	resetTreeItems() Reset the cached tree paths list.
void	setRecursive(boolean recursive) Sets the recursive attribute.
protected void	setSelectedIndex(int index, boolean incremental) Sets the selected index.
void	uninstallListeners() Uninstall the listeners that installed before.

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

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

Methods inherited from class java.lang.Object

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

Property Detail

recursive

public javafx.beans.property.BooleanProperty recursiveProperty

See Also:

isRecursive(), setRecursive(boolean)

Constructor Detail

TreeViewSearchable

public TreeViewSearchable(javafx.scene.control.TreeView<T> treeView)

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<javafx.scene.control.TreeItem<T>>

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<javafx.scene.control.TreeItem<T>>

recursiveProperty

public javafx.beans.property.BooleanProperty recursiveProperty()

See Also:

isRecursive(), setRecursive(boolean)

isRecursive

public boolean isRecursive()

Checks if the searchable is recursive.

Returns:

true if searchable is recursive.

setRecursive

public void setRecursive(boolean recursive)

Sets the recursive attribute.

If TreeSearchable is recursive, it will 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.

Parameters:

recursive - the attribute

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<javafx.scene.control.TreeItem<T>>

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.

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<javafx.scene.control.TreeItem<T>>

Returns:

the selected index.

getElementAt

protected javafx.scene.control.TreeItem<T> 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<javafx.scene.control.TreeItem<T>>

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<javafx.scene.control.TreeItem<T>>

Returns:

the total element count.

populateTreePaths

protected void populateTreePaths()

Recursively go through the tree to populate the tree paths into a list and cache them.

Tree paths list is only used when recursive attribute is true.

resetTreeItems

protected void resetTreeItems()

Reset the cached tree paths list.

Tree paths list is only used when recursive attributes true.

getTreeItems

protected java.util.List<javafx.scene.control.TreeItem> getTreeItems()

Gets the cached tree paths list. If it has never been cached before, this method will create the cache.

Tree paths list is only used when recursive attributes true.

Returns:

the tree paths list.

convertElementToString

protected java.lang.String convertElementToString(javafx.scene.control.TreeItem<T> object)

Converts the element in TreeView to string. The element by default is TreePath. The returned value will be toString() of the last path component in the TreePath.

Specified by:

convertElementToString in class Searchable<javafx.scene.control.TreeItem<T>>

Parameters:

object - the object to be converted

Returns:

the string representing the TreePath in the TreeView.