jidefx.scene.control.hints

Class AbstractListIntelliHints<T>

java.lang.Object

jidefx.scene.control.hints.AbstractIntelliHints<T>

jidefx.scene.control.hints.AbstractListIntelliHints<T>

All Implemented Interfaces:

IntelliHints<T>

Direct Known Subclasses:

FileIntelliHints, ListDataIntelliHints

public abstract class AbstractListIntelliHints<T>
extends AbstractIntelliHints<T>

AbstractListIntelliHints extends AbstractIntelliHints and further implement most of the methods in interface IntelliHints. In this class, it assumes the hints can be represented as a ListView, so it used ListView in the hints popup.

Property Summary

Properties inherited from class jidefx.scene.control.hints.AbstractIntelliHints

autoPopupProperty, showHintsDelayProperty

Field Summary

Fields inherited from interface jidefx.scene.control.hints.IntelliHints

PROPERTY_INTELLI_HINTS

Constructor Summary

Constructors

Constructor and Description
AbstractListIntelliHints(javafx.scene.control.TextInputControl textInputControl) Creates a Completion for a TextInputControl

Method Summary

Modifier and Type	Method and Description
javafx.scene.Node	createHintsNode() Creates the node which contains hints.
protected javafx.scene.control.ListView<T>	createListView() Creates the list to display the hints.
javafx.scene.input.KeyCombination[]	getDelegateKeyCombination() Gets the delegate keystrokes.
javafx.scene.Node	getDelegateNode() Gets the delegate node in the hint popup.
protected javafx.scene.control.ListView<T>	getListView() Gets the list.
T	getSelectedHint() Gets the selected hint.
protected void	setAvailableHints(javafx.collections.ObservableList<T> hints) Sets the available hints.

Methods inherited from class jidefx.scene.control.hints.AbstractIntelliHints

acceptHint, addShowHintsKeyCombination, autoPopupProperty, createPopup, getAllShowHintsKeyStrokes, getContext, getIntelliHints, getShowHintsDelay, getShowHintsKeyCombination, getTextInputControl, hideHintsPopup, isAutoPopup, isHintsPopupVisible, isMultiline, removeShowHintKeyCombination, setAutoPopup, setHintsEnabled, setShowHintsDelay, showHints, showHintsDelayProperty, showHintsPopup

Methods inherited from class java.lang.Object

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

Methods inherited from interface jidefx.scene.control.hints.IntelliHints

updateHints

Constructor Detail

AbstractListIntelliHints

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

Creates a Completion for a TextInputControl

Parameters:

textInputControl - the control where the intelliHints will be installed to.

Method Detail

createHintsNode

public javafx.scene.Node createHintsNode()

Description copied from interface: IntelliHints

Creates the node which contains hints. At this moment, the content should be empty. Following call IntelliHints.updateHints(Object) will update the content.

Returns:

the node which will be used to display the hints.

createListView

protected javafx.scene.control.ListView<T> createListView()

Creates the list to display the hints. By default, we create a ListView using the code below.

Returns:

the list.

getListView

protected javafx.scene.control.ListView<T> getListView()

Gets the list.

Returns:

the list.

setAvailableHints

protected void setAvailableHints(javafx.collections.ObservableList<T> hints)

Sets the available hints.

Parameters:

hints - the list of hints

getSelectedHint

public T getSelectedHint()

Description copied from interface: IntelliHints

Gets the selected hint. This hint will be used to complete the text control using IntelliHints.acceptHint(Object).

Returns:

the selected hint.

getDelegateNode

public javafx.scene.Node getDelegateNode()

Description copied from class: AbstractIntelliHints

Gets the delegate node in the hint popup.

Specified by:

getDelegateNode in class AbstractIntelliHints<T>

Returns:

the node that will receive the keystrokes that are delegated to hint popup.

getDelegateKeyCombination

public javafx.scene.input.KeyCombination[] getDelegateKeyCombination()

Gets the delegate keystrokes. Since we know the hints popup is a ListView, we return eight keystrokes so that they can be delegate to the ListView. Those keystrokes are DOWN, UP, PAGE_DOWN, PAGE_UP, HOME and END.

Specified by:

getDelegateKeyCombination in class AbstractIntelliHints<T>

Returns:

the keystrokes that will be delegated to the ListView when hints popup is visible.