jidefx.scene.control.searchable

Class ChoiceBoxSearchable<T>

java.lang.Object

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

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

Type Parameters:

T - the element type in the ChoiceBox.

public class ChoiceBoxSearchable<T>
extends Searchable<T>

ChoiceBoxSearchable is an concrete implementation of Searchable that enables the search function on non-editable ChoiceBox.

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

 ChoiceBox choiceBox = ....;
 ChoiceBoxSearchable searchable = new ChoiceBoxSearchable(choiceBox);
 

Now the ChoiceBox will have the search function.

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

 ChoiceBox choiceBox = ....;
 ChoiceBoxSearchable searchable = new ChoiceBoxSearchable(choiceBox) {
      protected String convertElementToString(Object object) {
          ...
      }
 };
 

Property Summary

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

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
ChoiceBoxSearchable(javafx.scene.control.ChoiceBox<T> choiceBox)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	convertElementToString(T element) Converts the element that returns from getElementAt() to string.
protected 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.
void	installListeners() Installs necessary listeners to the control.
boolean	isShowPopup() Gets the value of the property showPopup.
protected void	setSelectedIndex(int index, boolean incremental) Sets the selected index.
void	setShowPopup(boolean showPopup) Sets the value of the property showPopup.
javafx.beans.property.BooleanProperty	showPopupProperty()
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

showPopup

public javafx.beans.property.BooleanProperty showPopupProperty

See Also:

isShowPopup(), setShowPopup(boolean)

Constructor Detail

ChoiceBoxSearchable

public ChoiceBoxSearchable(javafx.scene.control.ChoiceBox<T> choiceBox)

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<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<T>

showPopupProperty

public javafx.beans.property.BooleanProperty showPopupProperty()

See Also:

isShowPopup(), setShowPopup(boolean)

isShowPopup

public boolean isShowPopup()

Gets the value of the property showPopup.

setShowPopup

public void setShowPopup(boolean showPopup)

Sets the value of the property showPopup.

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<T>

Returns:

the selected index.

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<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.

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<T>

Returns:

the total element count.

getElementAt

protected 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<T>

Parameters:

index - the index

Returns:

the element at the specified index.

convertElementToString

protected java.lang.String convertElementToString(T element)

Description copied from class: Searchable

Converts the element that returns from getElementAt() to string.

Specified by:

convertElementToString in class Searchable<T>

Parameters:

element - the element to be converted

Returns:

the string representing the element in the control.