jidefx.scene.control.hints

Class AbstractIntelliHints<T>

java.lang.Object

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

All Implemented Interfaces:

IntelliHints<T>

Direct Known Subclasses:

AbstractListIntelliHints

public abstract class AbstractIntelliHints<T>
extends java.lang.Object
implements IntelliHints<T>

AbstractIntelliHints is an abstract implementation of IntelliHints. It covers functions such as showing the hint popup at the correct position, delegating keystrokes, updating and selecting hint. The only thing that is left out to subclasses is the creation of the hint popup.

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	autoPopup
javafx.beans.property.ObjectProperty<javafx.util.Duration>	showHintsDelay

Field Summary

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

PROPERTY_INTELLI_HINTS

Constructor Summary

Constructors

Constructor and Description
AbstractIntelliHints(javafx.scene.control.TextInputControl textInputControl) Creates an IntelliHints object for a given TextInputControl such as TextField or TextArea.

Method Summary

Modifier and Type	Method and Description
void	acceptHint(T selected) After user has selected a item in the hints popup, this method will update TextInputControl accordingly to accept the hint.
void	addShowHintsKeyCombination(javafx.scene.input.KeyCombination combination) Adds a new key stroke to show hints popup.
javafx.beans.property.BooleanProperty	autoPopupProperty()
protected javafx.stage.Popup	createPopup()
javafx.scene.input.KeyCombination[]	getAllShowHintsKeyStrokes() Gets all key strokes that will show hints popup.
protected java.lang.Object	getContext() Gets the context for hints.
protected abstract javafx.scene.input.KeyCombination[]	getDelegateKeyCombination() Gets the delegate keystrokes.
protected abstract javafx.scene.Node	getDelegateNode() Gets the delegate node in the hint popup.
static <T> IntelliHints<T>	getIntelliHints(javafx.scene.Node node) Gets the IntelliHints object if it was installed on the node before.
javafx.util.Duration	getShowHintsDelay() Gets the delay after the key is pressed to show hints.
protected javafx.scene.input.KeyCombination	getShowHintsKeyCombination() Gets the keystroke that will trigger the hint popup.
javafx.scene.control.TextInputControl	getTextInputControl()
protected void	hideHintsPopup() Hides the hints popup.
boolean	isAutoPopup() Returns whether the hints popup is automatically displayed.
boolean	isHintsPopupVisible() Checks if the hints popup is visible.
protected boolean	isMultiline() Returns whether this IntelliHints' TextInputControl supports single-line text or multi-line text.
void	removeShowHintKeyCombination(javafx.scene.input.KeyCombination combination) Removes a key stroke from the list to show hints popup.
void	setAutoPopup(boolean autoPopup) Sets whether the popup should be displayed automatically.
void	setHintsEnabled(boolean enabled) Enables or disables the hints popup.
void	setShowHintsDelay(javafx.util.Duration showHintsDelay) Sets the delay after the key is pressed to show hints.
void	showHints() Shows the hints popup which contains the hints.
javafx.beans.property.ObjectProperty<javafx.util.Duration>	showHintsDelayProperty()
protected void	showHintsPopup() This method will call showHints() if and only if the text control is enabled and has focus.

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

createHintsNode, getSelectedHint, updateHints

Property Detail

autoPopup

public javafx.beans.property.BooleanProperty autoPopupProperty

See Also:

isAutoPopup(), setAutoPopup(boolean)

showHintsDelay

public javafx.beans.property.ObjectProperty<javafx.util.Duration> showHintsDelayProperty

See Also:

getShowHintsDelay(), setShowHintsDelay(Duration)

Constructor Detail

AbstractIntelliHints

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

Creates an IntelliHints object for a given TextInputControl such as TextField or TextArea.

Parameters:

textInputControl - the text input control.

Method Detail

createPopup

protected javafx.stage.Popup createPopup()

getTextInputControl

public javafx.scene.control.TextInputControl getTextInputControl()

acceptHint

public void acceptHint(T selected)

After user has selected a item in the hints popup, this method will update TextInputControl accordingly to accept the hint.

For TextArea, the default implementation will insert the hint into current caret position. For TextField, by default it will replace the whole content with the item user selected. Subclass can always choose to override it to accept the hint in a different way. For example, FileIntelliHints will append the selected item at the end of the existing text in order to complete a full file path.

Specified by:

acceptHint in interface IntelliHints<T>

Parameters:

selected - the selected hint

isMultiline

protected boolean isMultiline()

Returns whether this IntelliHints' TextInputControl supports single-line text or multi-line text.

Returns:

true if the node supports multiple text lines, false otherwise.

showHintsPopup

protected void showHintsPopup()

This method will call showHints() if and only if the text control is enabled and has focus.

showHints

public void showHints()

Shows the hints popup which contains the hints. It will call IntelliHints.updateHints(Object). Only if it returns true, the popup will be shown. You can call this method to fore the hints to be displayed.

getContext

protected java.lang.Object getContext()

Gets the context for hints. The context is the information that IntelliHints needs in order to generate a list of hints. For example, for code-completion, the context is current word the cursor is on. for file completion, the context is the full string starting from the file system root.

We provide a default context in AbstractIntelliHints. If it's a TextArea, the context will be the string at the caret line from line beginning to the caret position. If it's a TextField, the context will be whatever string in the text field. Subclass can always override it to return the context that is appropriate.

Returns:

the context.

hideHintsPopup

protected void hideHintsPopup()

Hides the hints popup.

setHintsEnabled

public void setHintsEnabled(boolean enabled)

Enables or disables the hints popup.

Parameters:

enabled - true to enable the hints popup. Otherwise false.

isHintsPopupVisible

public boolean isHintsPopupVisible()

Checks if the hints popup is visible.

Returns:

true if it's visible. Otherwise, false.

autoPopupProperty

public javafx.beans.property.BooleanProperty autoPopupProperty()

See Also:

isAutoPopup(), setAutoPopup(boolean)

isAutoPopup

public boolean isAutoPopup()

Returns whether the hints popup is automatically displayed. Default is true

Returns:

true if the popup should be automatically displayed. False will never show it automatically and then need the user to manually activate it via the getShowHintsKeyStroke() key binding.

See Also:

setAutoPopup(boolean)

setAutoPopup

public void setAutoPopup(boolean autoPopup)

Sets whether the popup should be displayed automatically. If autoPopup is true then is the popup automatically displayed whenever updateHints() return true. If autoPopup is false it's not automatically displayed and will need the user to activate the key binding defined by getShowHintsKeyStroke().

Parameters:

autoPopup - true or false

getDelegateKeyCombination

protected abstract javafx.scene.input.KeyCombination[] getDelegateKeyCombination()

Gets the delegate keystrokes.

When hint popup is visible, the keyboard focus never leaves the text control. However the hint popup usually contains a control that user will try to use navigation key to select an item. For example, use UP and DOWN key to navigate the list. Those keystrokes, if the popup is visible, will be delegated to the the control that returns from getDelegateNode().

NOTE: Since this method would be invoked inside the constructor of AbstractIntelliHints, please do not try to return a field because the field is not initiated yet at this time.

Returns:

an array of keystrokes that will be delegate to getDelegateNode() when hint popup is shown.

getDelegateNode

protected abstract javafx.scene.Node getDelegateNode()

Gets the delegate node in the hint popup.

Returns:

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

getShowHintsKeyCombination

protected javafx.scene.input.KeyCombination getShowHintsKeyCombination()

Gets the keystroke that will trigger the hint popup. Usually the hints popup will be shown automatically when user types. Only when the hint popup is hidden accidentally, this keystroke will show the popup again.

By default, it's the DOWN key for TextField and CTRL+SPACE for TextArea.

Returns:

the keystroke that will trigger the hint popup.

showHintsDelayProperty

public javafx.beans.property.ObjectProperty<javafx.util.Duration> showHintsDelayProperty()

See Also:

getShowHintsDelay(), setShowHintsDelay(Duration)

setShowHintsDelay

public void setShowHintsDelay(javafx.util.Duration showHintsDelay)

Sets the delay after the key is pressed to show hints. You can set it to Duration.ZERO which means no delay, or Duration.INDEFINITE which means the hints popup will not show until user presses the down arrow key.

By default, the delay time is 200ms Duration.

Parameters:

showHintsDelay - the delay time

getShowHintsDelay

public javafx.util.Duration getShowHintsDelay()

Gets the delay after the key is pressed to show hints.

Returns:

the delay duration.

See Also:

setShowHintsDelay(Duration)

addShowHintsKeyCombination

public void addShowHintsKeyCombination(javafx.scene.input.KeyCombination combination)

Adds a new key stroke to show hints popup.

Parameters:

combination - the key stroke

See Also:

removeShowHintKeyCombination(KeyCombination), getAllShowHintsKeyStrokes()

removeShowHintKeyCombination

public void removeShowHintKeyCombination(javafx.scene.input.KeyCombination combination)

Removes a key stroke from the list to show hints popup.

Parameters:

combination - the key stroke

getAllShowHintsKeyStrokes

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

Gets all key strokes that will show hints popup.

Returns:

the key stroke array.

getIntelliHints

public static <T> IntelliHints<T> getIntelliHints(javafx.scene.Node node)

Gets the IntelliHints object if it was installed on the node before.

Type Parameters:

T - the data type of the hints

Parameters:

node - the node that has IntelliHints installed

Returns:

the IntelliHints.