JFXAutoComplete (DocJGenerator Help API)

java.lang.Object
- org.docgene.help.gui.jfx.autocomplete.JFXAutoComplete

All Implemented Interfaces:

AutoComplete
```
public class JFXAutoComplete
extends java.lang.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 one property:
- acceptDuplicates(boolean): true if the dictionnary accept duplicates
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

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.

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.

Constructors
Constructor and Description
`JFXAutoComplete(javafx.scene.control.TextInputControl textComponent)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acceptDuplicates(boolean acceptDuplicates)` Set if the dictionnary accept duplicates.
`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.
`int`	`getResultsLimit()` Return the results limits.
`java.lang.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.
`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`	`setResultsLimit(int limit)` Set the results limits.

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 has an opacity of 1
    - Duplicates in the dictionnary are allowed
    Parameters:
    
    textComponent - the text Component
- 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
  - addAdditionalSearchText
```
public 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.
    
    Specified by:
    
    addAdditionalSearchText in interface AutoComplete
    
    Parameters:
    
    text - the text 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
  - 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
  - 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
  - getText
```
public final java.lang.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.
    
    Specified by:
    
    addCategoryToSuggestions in interface AutoComplete
    
    Parameters:
    
    category - the category
  - addItemToSuggestions
```
public boolean addItemToSuggestions(java.lang.String category,
                                    AutoCompleteDictionary.Item item)
```
    Add a category to the list of suggestions in the Popup Window.
    
    Specified by:
    
    addItemToSuggestions in interface AutoComplete
    
    Parameters:
    
    category - the category name
    
    item - the Item
    
    Returns:
    
    true if the item could be added
  - addAdditionalSearchSuggestion
```
public void addAdditionalSearchSuggestion(java.lang.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 void addCategory(java.lang.String category)
```
    Add a category to the dictionary.
    
    Specified by:
    
    addCategory in interface AutoComplete
    
    Parameters:
    
    category - the category name
  - addToDictionary
```
public void addToDictionary(java.lang.String word)
```
    Add a word to the dictionary to use for the autoComplete.
    
    Specified by:
    
    addToDictionary in interface AutoComplete
    
    Parameters:
    
    word - the word
  - addToDictionary
```
public void addToDictionary(AutoCompleteDictionary.Item item)
```
    Add an item to the dictionary to use for the autoComplete.
    
    Specified by:
    
    addToDictionary in interface AutoComplete
    
    Parameters:
    
    item - the item
  - addToDictionary
```
public void addToDictionary(java.lang.String category,
                            java.lang.String word)
```
    Add a word to the dictionary to use for the autoComplete.
    
    Specified by:
    
    addToDictionary in interface AutoComplete
    
    Parameters:
    
    category - the item category
    
    word - the word
  - addToDictionary
```
public void addToDictionary(java.lang.String category,
                            AutoCompleteDictionary.Item item)
```
    Add an item to the dictionary to use for the autoComplete.
    
    Specified by:
    
    addToDictionary in interface AutoComplete
    
    Parameters:
    
    category - the item category
    
    item - the item
  - getTextComponent
```
public javafx.scene.control.TextInputControl getTextComponent()
```
    Return the text component.
    
    Returns:
    
    the text component

Class JFXAutoComplete

Customization

CSS styling

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

textComponent

Constructor Detail

JFXAutoComplete

Method Detail

setMaximumPopupSize

addAdditionalSearchText

hasAdditionalSearchItem

setResultsLimit

getResultsLimit

hasDefaultCategory

acceptDuplicates

isAcceptingDuplicates

getText

addCategoryToSuggestions

addItemToSuggestions

addAdditionalSearchSuggestion

resetDictionary

getDictionary

setDictionnary

addCategory

addCategory

addToDictionary

addToDictionary

addToDictionary

addToDictionary

getTextComponent