org.mdiutil.jfx.autocomplete

Class JFXAutoComplete

java.lang.Object

org.mdiutil.jfx.autocomplete.JFXAutoComplete

All Implemented Interfaces:

AutoComplete

public class JFXAutoComplete
extends Object
implements AutoComplete

An Autocomplete class, usable with a TextInputControl, which allows to add Autocomplete behavior to the text component. This class can be used in two main ways:

• Autocompleting the text "inline" in the text component
• Showing a Popup window with the list of possible choices and allow to choose between these choices

Customization

The class can also be customized through several properties:

• setCaseSensitive(boolean): true if case is sensitive for the search
• searchHitsFromStart(boolean): true if the Search for hits is performed from the start of the typed text only. For example the dictionnary word "conf" would be a hit for the text "unconfirmed" if this property was set to false, and false if it was set to true. There would be a hit in the two cases for the text "confirmed"
• showPopup(boolean): true if a Popup Window presenting the possible hits should be presented. if false, the first hit will be automatically used for the completion
• acceptDuplicates(boolean): true if the dictionnary accept duplicates
• startSearchOnKeyCode(javafx.scene.input.KeyCode): the keyCode to use to start the search. By default the search is started immediately during the typing. If the keyCode is strictly greater than 0, the search will be started by typing this keyCode with the Control key down
• searchPerWord(boolean): true if the Search is performed per each word

Moreover, it is possible to customize the way the list of suggestions is presented, and to change the default search engine used to check for hits.

CSS styling

The JFXAutoComplete uses the following components and styleClasses:

• A ListView for the list, with the "autoComplete-list" styleClass
• A Label for the categories (if they are used), with the "autoComplete-category" styleClass
• A JFXAutoComplete.SuggestedHit (also a Label) for the suggestions, with the "autoComplete-hit" styleClass if categories are not used, and "autoComplete-hit-category" if categories are used

Example

 TextField tf = new TextField();
 JFXAutoComplete autoCompleter = new JFXAutoComplete(tf);

 //add the dictionary
 autoCompleter.addToDictionary("hello");
 autoCompleter.addToDictionary("highlight");
 autoCompleter.addToDictionary("cruel world");
 autoCompleter.addToDictionary("war");
 autoCompleter.addToDictionary("wording");
 autoCompleter.addToDictionary("world");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JFXAutoComplete.SuggestedHit The Label used for the Suggested Hits.
class	JFXAutoComplete.SuggestionHitsListView A panel for suggested hits.

Field Summary

Fields

Modifier and Type	Field and Description
protected javafx.scene.control.TextInputControl	textComponent The text component.

Constructor Summary

Constructors

Constructor and Description
JFXAutoComplete(javafx.scene.control.TextInputControl textComponent) Constructor.
JFXAutoComplete(javafx.scene.control.TextInputControl textComponent, boolean showPopup) Constructor.

Method Summary

Modifier and Type	Method and Description
void	acceptDuplicates(boolean acceptDuplicates) Set if the dictionnary accept duplicates.
void	addAdditionalSearchItem(String template) Add the additional search item in the popup.
void	addAdditionalSearchSuggestion(String typedText) Add the additional search text suggestion in the popup Window.
boolean	addCategory(AutoCompleteDictionary.Category category) Add a category to the dictionary.
AutoCompleteDictionary.Category	addCategory(String category) Add a category to the dictionary.
void	addCategoryToSuggestions(AutoCompleteDictionary.Category category) Add a category to the list of suggestions in the Popup Window.
boolean	addItemToSuggestions(String category, AutoCompleteDictionary.Item item) Add a category to the list of suggestions in the Popup Window.
boolean	addToDictionary(AutoCompleteDictionary.Item item) Add an item to the dictionary to use for the autoComplete.
boolean	addToDictionary(String word) Add a word to the dictionary to use for the autoComplete.
boolean	addToDictionary(String category, AutoCompleteDictionary.Item item) Add an item to the dictionary to use for the autoComplete.
boolean	addToDictionary(String category, String word) Add a word to the dictionary to use for the autoComplete.
protected String	getAdditionalSearchLabel(String typedText) Return the full-text search label to show for the corresponding item.
AutoCompleteDictionary	getDictionary() Return the dictionnary used for the Autocompletion.
int	getResultsLimit() Return the results limits.
javafx.scene.input.KeyCode	getSearchOnKeyCode() Return the KeyCode to use to start the search By default the search is started immediately during the typing.
String	getText() Return the text component text.
javafx.scene.control.TextInputControl	getTextComponent() Return the text component.
boolean	hasAdditionalSearchItem() Return true if there is an additional search item in the popup.
boolean	hasDefaultCategory() Return true if the dictionnary uses only the default category.
boolean	isAcceptingDuplicates() Return true if the dictionnary accept duplicates.
boolean	isCaseSensitive() Return true if the search is case sensitive.
boolean	isSearchingHitsFromStart() Return true if the search begins from the start of the typed text.
boolean	isSearchingPerWord() Return true if the search is performed per each typed word.
boolean	isShowingPopup() Return true if the Popup Window with the words suggestions must be presented during typing.
boolean	isStartingSearchImmediately() Return true if the search is started immediately during the typing.
boolean	removeCategory(AutoCompleteDictionary.Category category) Remove a category from the dictionary.
boolean	removeCategory(String category) Add a category to the dictionary.
boolean	removeFromDictionary(AutoCompleteDictionary.Item item) Remove an item from the dictionary to use for the autoComplete.
boolean	removeFromDictionary(String word) Remove a word from the dictionary to use for the autoComplete.
boolean	removeFromDictionary(String category, AutoCompleteDictionary.Item item) Remove an item from the dictionary to use for the autoComplete.
boolean	removeFromDictionary(String category, String word) Remove a word from the dictionary to use for the autoComplete.
void	resetDictionary() Reset the Dictionnary to use for the autoComplete.
void	searchHitsFromStart(boolean fromStart) Set if the search begins from the start of the typed text.
void	searchPerWord(boolean searchPerWord) Set if the search is performed per each typed word.
void	setCaseSensitive(boolean caseSensitive) Set if the search is case sensitive.
void	setDictionnary(AutoCompleteDictionary dictionary) Set the dictionnary used for the Autocompletion.
void	setMaximumPopupSize(int maxWidth, int maxHeight) Set the maximum width and height of the Popup.
void	setOnlineEngine(AutoCompleteOnlineEngine engine) Set the search engine used for the Autocomplete without Popup.
void	setPopupEngine(AutoCompleteEngine engine) Set the search engine used for the Autocomplete with Popup.
void	setResultsLimit(int limit) Set the results limits.
void	showPopup(boolean showPopup) Set if the Popup Window with the words suggestions must be presented during typing.
void	startSearchOnKeyCode(javafx.scene.input.KeyCode keyCode) Set the KeyCode to use to start the search.

Methods inherited from class java.lang.Object

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

Field Detail

textComponent

protected javafx.scene.control.TextInputControl textComponent

The text component.

Constructor Detail

JFXAutoComplete

public JFXAutoComplete(javafx.scene.control.TextInputControl textComponent)

Constructor. The default parameters are:

• The Popup Window is presented with the suggested words during typing
• The Popup Window has an opacity of 1
• Search is only performed from the start of the typed text
• Search is not case-sensitive
• Duplicates in the dictionnary are allowed
• The search is active immediately during the typing
• The search is performed for the whole text

Parameters:

textComponent - the text Component

JFXAutoComplete

public JFXAutoComplete(javafx.scene.control.TextInputControl textComponent,
                       boolean showPopup)

Constructor. The default parameters are:

• The Popup Window, if presented, has an opacity of 1
• Search is only performed from the start of the typed text
• Search is not case-sensitive
• Duplicates in the dictionnary are allowed
• The search is active immediately during the typing
• The search is performed for the whole text

Parameters:

textComponent - the text Component

showPopup - true if the Popup Window is presented with the suggested words during typing

Method Detail

setMaximumPopupSize

public void setMaximumPopupSize(int maxWidth,
                                int maxHeight)

Set the maximum width and height of the Popup.

Specified by:

setMaximumPopupSize in interface AutoComplete

Parameters:

maxWidth - the maximum width of the Popup

maxHeight - the maximum height of the Popup

addAdditionalSearchItem

public void addAdditionalSearchItem(String template)

Add the additional search item in the popup. It can be used to add an additional item in the list of suggestions, for example to add a full-text search option in the list of suggestions. Note that the template uses the syntax of the MessageConstructor utility class. For example If additionalSearchText = "Containing: $1", the result for the typed text "toto" will be "Containing: toto".

Specified by:

addAdditionalSearchItem in interface AutoComplete

Parameters:

template - the template for the additional search item

hasAdditionalSearchItem

public boolean hasAdditionalSearchItem()

Return true if there is an additional search item in the popup.

Specified by:

hasAdditionalSearchItem in interface AutoComplete

Returns:

true if there is an additional search item in the popup

hasDefaultCategory

public boolean hasDefaultCategory()

Return true if the dictionnary uses only the default category.

Returns:

true if the dictionnary uses only the default category

acceptDuplicates

public void acceptDuplicates(boolean acceptDuplicates)

Set if the dictionnary accept duplicates.

Parameters:

acceptDuplicates - true if the dictionnary accept duplicates

isAcceptingDuplicates

public boolean isAcceptingDuplicates()

Return true if the dictionnary accept duplicates.

Returns:

true if the dictionnary accept duplicates

startSearchOnKeyCode

public void startSearchOnKeyCode(javafx.scene.input.KeyCode keyCode)

Set the KeyCode to use to start the search. By default the search is started immediately during the typing. If the KeyCode is not null, the search will be started by typing this keyCode with the Control key down.

Parameters:

keyCode - the KeyCode to use to start the search

getSearchOnKeyCode

public javafx.scene.input.KeyCode getSearchOnKeyCode()

Return the KeyCode to use to start the search By default the search is started immediately during the typing. If the keyCode is not null, the search will be started by typing this keyCode with the Control key down.

Returns:

the KeyCode to use to start the search

isStartingSearchImmediately

public boolean isStartingSearchImmediately()

Return true if the search is started immediately during the typing.

Returns:

true if the search is started immediately during the typing

searchPerWord

public void searchPerWord(boolean searchPerWord)

Set if the search is performed per each typed word.

Parameters:

searchPerWord - true if the search is performed per each typed word

isSearchingPerWord

public boolean isSearchingPerWord()

Return true if the search is performed per each typed word.

Returns:

true iif the search is performed per each typed word

showPopup

public void showPopup(boolean showPopup)

Set if the Popup Window with the words suggestions must be presented during typing.

Parameters:

showPopup - if the Popup Window with the words suggestions must be presented

isShowingPopup

public boolean isShowingPopup()

Return true if the Popup Window with the words suggestions must be presented during typing.

Returns:

true if the Popup Window with the words suggestions must be presented

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Set if the search is case sensitive.

Parameters:

caseSensitive - if the search is case sensitive

isCaseSensitive

public boolean isCaseSensitive()

Return true if the search is case sensitive.

Specified by:

isCaseSensitive in interface AutoComplete

Returns:

true if the search is case sensitive

searchHitsFromStart

public void searchHitsFromStart(boolean fromStart)

Set if the search begins from the start of the typed text. Note that if isShowingPopup() is true, then the search will always being from start regardless of the value if this property.

Parameters:

fromStart - if the search begins from the start of the typed text

isSearchingHitsFromStart

public boolean isSearchingHitsFromStart()

Return true if the search begins from the start of the typed text.

Specified by:

isSearchingHitsFromStart in interface AutoComplete

Returns:

true if the search begins from the start of the typed text

setResultsLimit

public void setResultsLimit(int limit)

Set the results limits.

Parameters:

limit - the results limits

getResultsLimit

public int getResultsLimit()

Return the results limits. By default the results count is not limited and the result is -1.

Specified by:

getResultsLimit in interface AutoComplete

Returns:

the results limits

setPopupEngine

public void setPopupEngine(AutoCompleteEngine engine)

Set the search engine used for the Autocomplete with Popup.

Specified by:

setPopupEngine in interface AutoComplete

Parameters:

engine - the search engine

setOnlineEngine

public void setOnlineEngine(AutoCompleteOnlineEngine engine)

Set the search engine used for the Autocomplete without Popup.

Specified by:

setOnlineEngine in interface AutoComplete

Parameters:

engine - the search engine

getText

public final String getText()

Return the text component text.

Returns:

the text component text

addCategoryToSuggestions

public void addCategoryToSuggestions(AutoCompleteDictionary.Category category)

Add a category to the list of suggestions in the Popup Window. This method maybe used in an AutoCompleteEngine used for the search with a Popup Window.

Specified by:

addCategoryToSuggestions in interface AutoComplete

Parameters:

category - the category

See Also:

setPopupEngine(org.mdiutil.text.autocomplete.AutoCompleteEngine)

addItemToSuggestions

public boolean addItemToSuggestions(String category,
                                    AutoCompleteDictionary.Item item)

Add a category to the list of suggestions in the Popup Window. This method maybe used in an AutoCompleteEngine used for the search with a Popup Window.

Specified by:

addItemToSuggestions in interface AutoComplete

Parameters:

category - the category name

item - the Item

Returns:

true if the item could be added

See Also:

setPopupEngine(org.mdiutil.text.autocomplete.AutoCompleteEngine)

getAdditionalSearchLabel

protected String getAdditionalSearchLabel(String typedText)

Return the full-text search label to show for the corresponding item.

Parameters:

typedText - the typed text

Returns:

the full-text search label

addAdditionalSearchSuggestion

public void addAdditionalSearchSuggestion(String typedText)

Add the additional search text suggestion in the popup Window.

Specified by:

addAdditionalSearchSuggestion in interface AutoComplete

Parameters:

typedText - the typed text

resetDictionary

public void resetDictionary()

Reset the Dictionnary to use for the autoComplete.

Specified by:

resetDictionary in interface AutoComplete

getDictionary

public AutoCompleteDictionary getDictionary()

Return the dictionnary used for the Autocompletion.

Specified by:

getDictionary in interface AutoComplete

Returns:

the dictionnary

setDictionnary

public void setDictionnary(AutoCompleteDictionary dictionary)

Set the dictionnary used for the Autocompletion.

Specified by:

setDictionnary in interface AutoComplete

Parameters:

dictionary - the dictionnary

addCategory

public boolean addCategory(AutoCompleteDictionary.Category category)

Add a category to the dictionary.

Specified by:

addCategory in interface AutoComplete

Parameters:

category - the category

Returns:

true if the category did not previously exist

addCategory

public AutoCompleteDictionary.Category addCategory(String category)

Add a category to the dictionary. Note that if a category with the same name already exists, the existing category will be returned.

Specified by:

addCategory in interface AutoComplete

Parameters:

category - the category name

Returns:

the category

removeCategory

public boolean removeCategory(AutoCompleteDictionary.Category category)

Remove a category from the dictionary.

Specified by:

removeCategory in interface AutoComplete

Parameters:

category - the category

Returns:

true if the category did previously exist

removeCategory

public boolean removeCategory(String category)

Add a category to the dictionary.

Specified by:

removeCategory in interface AutoComplete

Parameters:

category - the category name

Returns:

true if the category did previously exist

addToDictionary

public boolean addToDictionary(String word)

Add a word to the dictionary to use for the autoComplete. If the dictionary use categories, the item won't be added.

Specified by:

addToDictionary in interface AutoComplete

Parameters:

word - the word

Returns:

true if the word could be added

addToDictionary

public boolean addToDictionary(AutoCompleteDictionary.Item item)

Add an item to the dictionary to use for the autoComplete. If the dictionary use categories, the item won't be added.

Specified by:

addToDictionary in interface AutoComplete

Parameters:

item - the item

Returns:

true if the item could be added

addToDictionary

public boolean addToDictionary(String category,
                               String word)

Add a word to the dictionary to use for the autoComplete. If the dictionary don't use categories, the word won't be added.

Specified by:

addToDictionary in interface AutoComplete

Parameters:

category - the item category

word - the word

Returns:

true if the word could be added

addToDictionary

public boolean addToDictionary(String category,
                               AutoCompleteDictionary.Item item)

Add an item to the dictionary to use for the autoComplete. If the dictionary don't use categories, the item won't be added.

Specified by:

addToDictionary in interface AutoComplete

Parameters:

category - the item category

item - the item

Returns:

true if the item could be added

removeFromDictionary

public boolean removeFromDictionary(String word)

Remove a word from the dictionary to use for the autoComplete. If the dictionary use categories, or the word does not exist, no word will be removed.

Specified by:

removeFromDictionary in interface AutoComplete

Parameters:

word - the word

Returns:

true if the word was removed

removeFromDictionary

public boolean removeFromDictionary(AutoCompleteDictionary.Item item)

Remove an item from the dictionary to use for the autoComplete. If the dictionary use categories, or the item does not exist, no item will be removed.

Specified by:

removeFromDictionary in interface AutoComplete

Parameters:

item - the item

Returns:

true if the item was removed

removeFromDictionary

public boolean removeFromDictionary(String category,
                                    String word)

Remove a word from the dictionary to use for the autoComplete. If the dictionary don't use categories, or the word does not exist, no word will be removed.

Specified by:

removeFromDictionary in interface AutoComplete

Parameters:

category - the item category

word - the word

Returns:

true if the item was removed

removeFromDictionary

public boolean removeFromDictionary(String category,
                                    AutoCompleteDictionary.Item item)

Remove an item from the dictionary to use for the autoComplete. If the dictionary don't use categories, or the item does not exist, no item will be removed.

Specified by:

removeFromDictionary in interface AutoComplete

Parameters:

category - the item category

item - the item

Returns:

true if the item was removed

getTextComponent

public javafx.scene.control.TextInputControl getTextComponent()

Return the text component.

Returns:

the text component