jidefx.scene.control.hints

Interface IntelliHints<T>

Type Parameters:

T - the data type of the hints

All Known Implementing Classes:

AbstractIntelliHints, AbstractListIntelliHints, FileIntelliHints, ListDataIntelliHints

public interface IntelliHints<T>

IntelliHints is an interface that defines all necessary methods to implement showing a hint popup depending on a context and allows user to pick from a list of hints. createHintsNode() will create a node that contains the hints. It will be shown in a popup window. After the hint popup is created, updateHints(Object) will update the content of hints based on the context. Once user picks a hint from the hint popup, getSelectedHint() will be called to find the hint that user selected and call acceptHint(Object) to accept it.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_INTELLI_HINTS The key of a client property.

Method Summary

Modifier and Type	Method and Description
void	acceptHint(T hint) Accepts the selected hint.
javafx.scene.Node	createHintsNode() Creates the node which contains hints.
T	getSelectedHint() Gets the selected hint.
boolean	updateHints(java.lang.Object context) Update hints depending on the context.

Field Detail

PROPERTY_INTELLI_HINTS

static final java.lang.String PROPERTY_INTELLI_HINTS

The key of a client property. If a node has IntelliHints registered, you can use this client property to get the IntelliHints instance.

See Also:

Constant Field Values

Method Detail

createHintsNode

javafx.scene.Node createHintsNode()

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

Returns:

the node which will be used to display the hints.

updateHints

boolean updateHints(java.lang.Object context)

Update hints depending on the context. This method will be triggered for every key typed event in the text control. Subclass can override it to provide your own list of hints and call AbstractListIntelliHints.setAvailableHints(javafx.collections.ObservableList) to set it and returns true after that.

Parameters:

context - the current context

Returns:

true or false. If it is false, hint popup will not be shown.

getSelectedHint

T getSelectedHint()

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

Returns:

the selected hint.

acceptHint

void acceptHint(T hint)

Accepts the selected hint. Subclass can implements to decide how the new hint be set to the text control.

Parameters:

hint - the hint to be accepted.