AutoComplete

All Known Implementing Classes:

JAutoComplete, JFXAutoComplete
```
public interface AutoComplete
```
An Autocomplete interface.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`addAdditionalSearchItem(String template)` Add the additional search item in the popup.
`default void`	`addAdditionalSearchSuggestion(String typedText)` Add the additional search text suggestion in the popup Window.Do nothing by default.
`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.This method maybe used in an `AutoCompleteEngine` used for the search with a 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.
`AutoCompleteDictionary`	`getDictionary()` Return the dictionnary used for the Autocompletion.
`default int`	`getResultsLimit()` Return the results limits.
`default boolean`	`hasAdditionalSearchItem()` Return true if there is an additional search item in the popup.
`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`	`removeCategory(AutoCompleteDictionary.Category category)` Remove a category from the dictionary.
`boolean`	`removeCategory(String category)` Remove a category from 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`	`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.

- 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
```
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.
    
    Parameters:
    
    category - the category name
    
    Returns:
    
    the category
  - removeCategory
```
boolean removeCategory(AutoCompleteDictionary.Category category)
```
    Remove a category from the dictionary.
    
    Parameters:
    
    category - the category
    
    Returns:
    
    true if the category did previously exist
  - removeCategory
```
boolean removeCategory(String category)
```
    Remove a category from the dictionary.
    
    Parameters:
    
    category - the category name
    
    Returns:
    
    true if there was a category to remove
  - addToDictionary
```
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.
    
    Parameters:
    
    word - the word
    
    Returns:
    
    true if the word could be added
  - addToDictionary
```
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.
    
    Parameters:
    
    item - the item
    
    Returns:
    
    true if the item could be added
  - addToDictionary
```
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.
    
    Parameters:
    
    category - the item category
    
    word - the word
    
    Returns:
    
    true if the word could be added
  - addToDictionary
```
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.
    
    Parameters:
    
    category - the item category
    
    item - the item
    
    Returns:
    
    true if the item could be added
  - removeFromDictionary
```
boolean removeFromDictionary(String word)
```
    Remove a word from the dictionary to use for the autoComplete. If the dictionary use categories, or the item does not exist, no word will be removed.
    
    Parameters:
    
    word - the word
    
    Returns:
    
    true if the word was removed
  - removeFromDictionary
```
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.
    
    Parameters:
    
    item - the item
    
    Returns:
    
    true if the item was removed
  - removeFromDictionary
```
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.
    
    Parameters:
    
    category - the item category
    
    word - the word
    
    Returns:
    
    true if the item was removed
  - removeFromDictionary
```
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.
    
    Parameters:
    
    category - the item category
    
    item - the item
    
    Returns:
    
    true if the item was removed
  - 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
  - setPopupEngine
```
void setPopupEngine(AutoCompleteEngine engine)
```
    Set the search engine used for the Autocomplete with Popup.
    
    Parameters:
    
    engine - the search engine
  - setOnlineEngine
```
void setOnlineEngine(AutoCompleteOnlineEngine engine)
```
    Set the search engine used for the Autocomplete without Popup.
    
    Parameters:
    
    engine - the search engine
  - 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
    
    See Also:
    
    setPopupEngine(org.mdiutil.text.autocomplete.AutoCompleteEngine)
  - addItemToSuggestions
```
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.
    
    Parameters:
    
    category - the category name
    
    item - the Item
    
    Returns:
    
    true if the item could be added
    
    See Also:
    
    setPopupEngine(org.mdiutil.text.autocomplete.AutoCompleteEngine)
  - addAdditionalSearchSuggestion
```
default void addAdditionalSearchSuggestion(String typedText)
```
    Add the additional search text suggestion in the popup Window.Do nothing by default.
    
    Parameters:
    
    typedText - the typed text
  - isCaseSensitive
```
boolean isCaseSensitive()
```
    Return true if the search is case sensitive.
    
    Returns:
    
    true if the search is case sensitive
  - isSearchingHitsFromStart
```
boolean isSearchingHitsFromStart()
```
    Return true if the search begins from the start of the typed text.
    
    Returns:
    
    true if the search begins from the start of the typed text
  - 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
  - addAdditionalSearchItem
```
default 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 cents", the result for the typed text "toto" will be "Containing: toto".
    
    Parameters:
    
    template - the template for the additional search item
  - hasAdditionalSearchItem
```
default 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

Interface AutoComplete

Method Summary

Method Detail

getDictionary

setDictionnary

resetDictionary

addCategory

addCategory

removeCategory

removeCategory

addToDictionary

addToDictionary

addToDictionary

addToDictionary

removeFromDictionary

removeFromDictionary

removeFromDictionary

removeFromDictionary

setMaximumPopupSize

setPopupEngine

setOnlineEngine

addCategoryToSuggestions

addItemToSuggestions

addAdditionalSearchSuggestion

isCaseSensitive

isSearchingHitsFromStart

getResultsLimit

addAdditionalSearchItem

hasAdditionalSearchItem