JAutoComplete (DocJGenerator Help API)

java.lang.Object
- org.docgene.help.gui.swing.autocomplete.JAutoComplete

All Implemented Interfaces:

AutoComplete
```
public class JAutoComplete
extends java.lang.Object
implements AutoComplete
```
An Autocomplete class, usable with a JTextComponent, which allows to add Autocomplete behavior to the text component. This class allows to show 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:
- setOpacity(float): the opacity of the Popup Window
- 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.
Example
```
 JTextField tf = new JTextField(10);
 AutoComplete2 autoCompleter = new AutoComplete2(tf);
 autoCompleter.setOpacity(0.9f);

 //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 JAutoComplete.SuggestedHit
The Label used for the Suggested Hits.

Nested Classes
Modifier and Type	Class and Description
`class`	`JAutoComplete.SuggestedHit` The Label used for the Suggested Hits.

Field Summary

Fields
Modifier and Type Field and Description

protected javax.swing.text.JTextComponent textComponent
The text component.

Fields
Modifier and Type	Field and Description
`protected javax.swing.text.JTextComponent`	`textComponent` The text component.

Constructor Summary

Constructors
Constructor and Description

JAutoComplete(javax.swing.text.JTextComponent textComponent)
Constructor.

Constructors
Constructor and Description
`JAutoComplete(javax.swing.text.JTextComponent 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.
`void`	`addAutoCompleteListener(AutoCompleteListener l)` Add an JAutoComplete listener.
`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`	`addSearchTextListener(AdditionalSearchListener l)` Add an containing text listener.
`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.
`java.util.List<AutoCompleteListener>`	`getAutoCompleteListeners()` Return the list of JAutoComplete listeners.
`java.util.List<AdditionalSearchListener>`	`getContainingTextListeners()` Return the list of containing text listeners.
`AutoCompleteDictionary`	`getDictionary()` Return the dictionnary used for the Autocompletion.
`float`	`getOpacity()` Return the Popup Window opacity.
`protected java.awt.Color`	`getPopUpBackgroundColor()` Return the background color of the suggested hits panel.
`protected java.awt.Color`	`getPopUpBorderColor()` Return the borded color of the suggested hits panel.
`int`	`getResultsLimit()` Return the results limits.
`protected java.awt.Color`	`getSuggestedHitFocusedColor()` Return the background color of the focused suggested hit.
`protected java.awt.Color`	`getSuggestedHitTextColor()` Return the color of the suggested hits text.
`java.lang.String`	`getText()` Return the text component text.
`javax.swing.text.JTextComponent`	`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`	`removeAutoCompleteListener(AutoCompleteListener l)` Removes an JAutoComplete listener.
`void`	`removeContainingTextListener(AdditionalSearchListener l)` Removes a containing text listener.
`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`	`setOpacity(float opacity)` Set the Popup Window opacity.
`void`	`setResultsLimit(int limit)` Set the results limits.
`protected void`	`updatePopupSize(int width, int height)` Update the PopUp Size.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - textComponent
```
protected javax.swing.text.JTextComponent textComponent
```
    The text component.
- Constructor Detail
  - JAutoComplete
```
public JAutoComplete(javax.swing.text.JTextComponent 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
  - setOpacity
```
public void setOpacity(float opacity)
```
    Set the Popup Window opacity.
    
    Parameters:
    
    opacity - the opacity
  - getOpacity
```
public float getOpacity()
```
    Return the Popup Window opacity.
    
    Returns:
    
    the opacity
  - 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
  - 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
  - getSuggestedHitTextColor
```
protected java.awt.Color getSuggestedHitTextColor()
```
    Return the color of the suggested hits text.
    
    Returns:
    
    the color
  - getSuggestedHitFocusedColor
```
protected java.awt.Color getSuggestedHitFocusedColor()
```
    Return the background color of the focused suggested hit.
    
    Returns:
    
    the color
  - getPopUpBackgroundColor
```
protected java.awt.Color getPopUpBackgroundColor()
```
    Return the background color of the suggested hits panel.
    
    Returns:
    
    the color
  - getPopUpBorderColor
```
protected java.awt.Color getPopUpBorderColor()
```
    Return the borded color of the suggested hits panel.
    
    Returns:
    
    the color
  - addAutoCompleteListener
```
public void addAutoCompleteListener(AutoCompleteListener l)
```
    Add an JAutoComplete listener.
    
    Parameters:
    
    l - the listener
  - removeAutoCompleteListener
```
public void removeAutoCompleteListener(AutoCompleteListener l)
```
    Removes an JAutoComplete listener.
    
    Parameters:
    
    l - the listener
  - getAutoCompleteListeners
```
public java.util.List<AutoCompleteListener> getAutoCompleteListeners()
```
    Return the list of JAutoComplete listeners.
    
    Returns:
    
    the list of JAutoComplete listeners
  - addSearchTextListener
```
public void addSearchTextListener(AdditionalSearchListener l)
```
    Add an containing text listener.
    
    Parameters:
    
    l - the listener
  - removeContainingTextListener
```
public void removeContainingTextListener(AdditionalSearchListener l)
```
    Removes a containing text listener.
    
    Parameters:
    
    l - the listener
  - getContainingTextListeners
```
public java.util.List<AdditionalSearchListener> getContainingTextListeners()
```
    Return the list of containing text listeners.
    
    Returns:
    
    the list of containing text listeners
  - 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. 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
  - addItemToSuggestions
```
public 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.
    
    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
  - 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
  - updatePopupSize
```
protected final void updatePopupSize(int width,
                                     int height)
```
    Update the PopUp Size.
    
    Parameters:
    
    width - the width of the element
    
    height - the height of the element
  - 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 javax.swing.text.JTextComponent getTextComponent()
```
    Return the text component.
    
    Returns:
    
    the text component

Class JAutoComplete

Customization

Example

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

textComponent

Constructor Detail

JAutoComplete

Method Detail

setMaximumPopupSize

setOpacity

getOpacity

hasDefaultCategory

acceptDuplicates

isAcceptingDuplicates

setResultsLimit

getResultsLimit

getSuggestedHitTextColor

getSuggestedHitFocusedColor

getPopUpBackgroundColor

getPopUpBorderColor

addAutoCompleteListener

removeAutoCompleteListener

getAutoCompleteListeners

addSearchTextListener

removeContainingTextListener

getContainingTextListeners

getText

addCategoryToSuggestions

addItemToSuggestions

addAdditionalSearchSuggestion

addAdditionalSearchText

hasAdditionalSearchItem

updatePopupSize

resetDictionary

getDictionary

setDictionnary

addCategory

addCategory

addToDictionary

addToDictionary

addToDictionary

addToDictionary

getTextComponent