org.docgene.help.gui.autocomplete

Interface AutoComplete

All Known Implementing Classes:

JAutoComplete, JFXAutoComplete

public interface AutoComplete

An Autocomplete interface.

Method Summary

Modifier and Type	Method and Description
void	addAdditionalSearchSuggestion(java.lang.String typedText) Add the additional search text suggestion in the popup Window.
void	addAdditionalSearchText(java.lang.String text) Add the additional search item in the popup.
boolean	addCategory(AutoCompleteDictionary.Category category) Add a category to the dictionary.
void	addCategory(java.lang.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(java.lang.String category, AutoCompleteDictionary.Item item) Add a category to the list of suggestions in the Popup Window.
void	addToDictionary(AutoCompleteDictionary.Item item) Add an item to the dictionary to use for the autoComplete.
void	addToDictionary(java.lang.String word) Add a word to the dictionary to use for the autoComplete.
void	addToDictionary(java.lang.String category, AutoCompleteDictionary.Item item) Add an item to the dictionary to use for the autoComplete.
void	addToDictionary(java.lang.String category, java.lang.String word) Add a word to the dictionary to use for the autoComplete.
AutoCompleteDictionary	getDictionary() Return the dictionnary used for the Autocompletion.
default int	getResultsLimit() Return the results limits.
boolean	hasAdditionalSearchItem() Return true if there is an additional search item in the popup.
void	resetDictionary() Reset the Dictionnary to use for the autoComplete.
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.

Method Detail

getDictionary

AutoCompleteDictionary getDictionary()

Return the dictionnary used for the Autocompletion.

Returns:

the dictionnary

setDictionnary

void setDictionnary(AutoCompleteDictionary dictionary)

Set the dictionnary used for the Autocompletion.

Parameters:

dictionary - the dictionnary

resetDictionary

void resetDictionary()

Reset the Dictionnary to use for the autoComplete.

addCategory

boolean addCategory(AutoCompleteDictionary.Category category)

Add a category to the dictionary.

Parameters:

category - the category

Returns:

true if the category did not previously exist

addCategory

void addCategory(java.lang.String category)

Add a category to the dictionary.

Parameters:

category - the category name

addToDictionary

void addToDictionary(java.lang.String word)

Add a word to the dictionary to use for the autoComplete.

Parameters:

word - the word

addToDictionary

void addToDictionary(AutoCompleteDictionary.Item item)

Add an item to the dictionary to use for the autoComplete.

Parameters:

item - the item

addToDictionary

void addToDictionary(java.lang.String category,
                     java.lang.String word)

Add a word to the dictionary to use for the autoComplete.

Parameters:

category - the item category

word - the word

addToDictionary

void addToDictionary(java.lang.String category,
                     AutoCompleteDictionary.Item item)

Add an item to the dictionary to use for the autoComplete.

Parameters:

category - the item category

item - the item

setMaximumPopupSize

void setMaximumPopupSize(int maxWidth,
                         int maxHeight)

Set the maximum width and height of the Popup.

Parameters:

maxWidth - the maximum width of the Popup

maxHeight - the maximum height of the Popup

addCategoryToSuggestions

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.

Parameters:

category - the category

addItemToSuggestions

boolean addItemToSuggestions(java.lang.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.

Parameters:

category - the category name

item - the Item

Returns:

true if the item could be added

addAdditionalSearchSuggestion

void addAdditionalSearchSuggestion(java.lang.String typedText)

Add the additional search text suggestion in the popup Window. Do nothing by default.

Parameters:

typedText - the typed text

addAdditionalSearchText

void addAdditionalSearchText(java.lang.String text)

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.

Parameters:

text - the text for the additional search item

hasAdditionalSearchItem

boolean hasAdditionalSearchItem()

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

Returns:

true if there is an additional search item in the popup

getResultsLimit

default int getResultsLimit()

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

Returns:

the results limits