JAutoComplete

java.lang.Object
- org.mdiutil.swing.autocomplete.JAutoComplete

All Implemented Interfaces:

AutoComplete
```
public class JAutoComplete
extends Object
implements AutoComplete
```
An Autocomplete class, usable with a JTextComponent, 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:
- setOpacity(float): the opacity of the Popup Window
- 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(int): 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.
Example
```
 JTextField tf = new JTextField(10);
 JAutoComplete autoCompleter = new JAutoComplete(tf);
 autoCompleter.setOpacity(0.9f);
 autoCompleter.searchHitsFromStart(false);

 //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.
`class`	`JAutoComplete.SuggestionHitsPanel` A panel for suggested hits.

Field Summary

Fields
Modifier and Type	Field and Description
`protected JAutoComplete.SuggestionHitsPanel`	`suggestedHitsPanel` The suggestion panel.
`protected JTextComponent`	`textComponent` The text component.

Constructor Summary

Constructors
Constructor and Description
`JAutoComplete(JTextComponent textComponent)` Constructor.
`JAutoComplete(JTextComponent textComponent, boolean showPopup)` 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`	`addAdditionalSearchItem(String text)` Add the additional search item in the popup.
`void`	`addAdditionalSearchSuggestion(String typedText)` Add the additional search text suggestion in the popup Window.
`void`	`addAutoCompleteListener(AutoCompleteListener l)` Add an JAutoComplete listener.
`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.
`void`	`addSearchTextListener(AdditionalSearchListener l)` Add an containing text listener.
`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.
`List<AutoCompleteListener>`	`getAutoCompleteListeners()` Return the list of JAutoComplete listeners.
`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 Color`	`getPopUpBackgroundColor()` Return the background color of the suggested hits panel.
`protected Color`	`getPopUpBorderColor()` Return the borded color of the suggested hits panel.
`int`	`getResultsLimit()` Return the results limits.
`int`	`getSearchOnKeyCode()` Return the keyCode to use to start the search By default the search is started immediately during the typing.
`protected Color`	`getSuggestedHitFocusedColor()` Return the background color of the focused suggested hit.
`protected Color`	`getSuggestedHitTextColor()` Return the color of the suggested hits text.
`String`	`getText()` Return the text component 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.
`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 perfoemd 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.
`void`	`removeAutoCompleteListener(AutoCompleteListener l)` Removes an JAutoComplete listener.
`boolean`	`removeCategory(AutoCompleteDictionary.Category category)` Remove a category from the dictionary.
`boolean`	`removeCategory(String category)` Add a category to the dictionary.
`void`	`removeContainingTextListener(AdditionalSearchListener l)` Removes a containing text listener.
`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 perfoemd 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`	`setOpacity(float opacity)` Set the Popup Window opacity.
`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(int keyCode)` Set the keyCode to use to start the search.
`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 JTextComponent textComponent
```
    The text component.
  - suggestedHitsPanel
```
protected JAutoComplete.SuggestionHitsPanel suggestedHitsPanel
```
    The suggestion panel.
- Constructor Detail
  - JAutoComplete
```
public JAutoComplete(JTextComponent 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
  - JAutoComplete
```
public JAutoComplete(JTextComponent 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 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:
    
    addAdditionalSearchItem in interface AutoComplete
    
    Parameters:
    
    text - the additional search text
  - 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
  - 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
  - startSearchOnKeyCode
```
public void startSearchOnKeyCode(int keyCode)
```
    Set 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.
    
    Parameters:
    
    keyCode - the keycode to use to start the search
  - getSearchOnKeyCode
```
public int getSearchOnKeyCode()
```
    Return 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.
    
    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 perfoemd per each typed word.
    
    Parameters:
    
    searchPerWord - true if the search is perfoemd per each typed word
  - isSearchingPerWord
```
public boolean isSearchingPerWord()
```
    Return true if the search is perfoemd per each typed word.
    
    Returns:
    
    true iif the search is perfoemd 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
  - getSuggestedHitTextColor
```
protected Color getSuggestedHitTextColor()
```
    Return the color of the suggested hits text.
    
    Returns:
    
    the color
  - getSuggestedHitFocusedColor
```
protected Color getSuggestedHitFocusedColor()
```
    Return the background color of the focused suggested hit.
    
    Returns:
    
    the color
  - getPopUpBackgroundColor
```
protected Color getPopUpBackgroundColor()
```
    Return the background color of the suggested hits panel.
    
    Returns:
    
    the color
  - getPopUpBorderColor
```
protected 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 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 List<AdditionalSearchListener> getContainingTextListeners()
```
    Return the list of containing text listeners.
    
    Returns:
    
    the list of containing text listeners
  - 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)
  - 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
  - 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. 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
    
    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 word 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 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

suggestedHitsPanel

Constructor Detail

JAutoComplete

JAutoComplete

Method Detail

setMaximumPopupSize

addAdditionalSearchItem

hasAdditionalSearchItem

setOpacity

getOpacity

hasDefaultCategory

acceptDuplicates

isAcceptingDuplicates

startSearchOnKeyCode

getSearchOnKeyCode

isStartingSearchImmediately

searchPerWord

isSearchingPerWord

showPopup

isShowingPopup

setCaseSensitive

isCaseSensitive

searchHitsFromStart

isSearchingHitsFromStart

setResultsLimit

getResultsLimit

setPopupEngine

setOnlineEngine

getSuggestedHitTextColor

getSuggestedHitFocusedColor

getPopUpBackgroundColor

getPopUpBorderColor

addAutoCompleteListener

removeAutoCompleteListener

getAutoCompleteListeners

addSearchTextListener

removeContainingTextListener

getContainingTextListeners

getText

addCategoryToSuggestions

addItemToSuggestions

addAdditionalSearchSuggestion

updatePopupSize

resetDictionary

getDictionary

setDictionnary

addCategory

addCategory

removeCategory

removeCategory

addToDictionary

addToDictionary

addToDictionary

addToDictionary

removeFromDictionary

removeFromDictionary

removeFromDictionary

removeFromDictionary

getTextComponent