org.jdesktop.swingx.autocomplete

Class TextComponentAdaptor

java.lang.Object

org.jdesktop.swingx.autocomplete.AbstractAutoCompleteAdaptor

org.jdesktop.swingx.autocomplete.TextComponentAdaptor

public class TextComponentAdaptor
extends AbstractAutoCompleteAdaptor

An implementation of the AbstractAutoCompleteAdaptor that is suitable for a JTextComponent.

Constructor Summary

Constructors

Constructor and Description
TextComponentAdaptor(javax.swing.text.JTextComponent textComponent, java.util.List<?> items) Creates a new TextComponentAdaptor for the given list and text component.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getItem(int index) Returns the item at a given index.
int	getItemCount() Returns the number of items in the list.
java.lang.Object	getSelectedItem() Returns the currently selected item.
javax.swing.text.JTextComponent	getTextComponent() Returns the text component that is being used for the automatic completion.
void	setSelectedItem(java.lang.Object item) Sets the selected item.

Methods inherited from class org.jdesktop.swingx.autocomplete.AbstractAutoCompleteAdaptor

getSelectedItemAsString, listContainsSelectedItem, markEntireText, markText, setSelectedItemAsString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextComponentAdaptor

public TextComponentAdaptor(javax.swing.text.JTextComponent textComponent,
                    java.util.List<?> items)

Creates a new TextComponentAdaptor for the given list and text component.

Parameters:

items - a List that contains the items that are used for automatic completion

textComponent - the text component that will be used automatic completion

Method Detail

getSelectedItem

public java.lang.Object getSelectedItem()

Description copied from class: AbstractAutoCompleteAdaptor

Returns the currently selected item.

Specified by:

getSelectedItem in class AbstractAutoCompleteAdaptor

Returns:

the selected item

getItemCount

public int getItemCount()

Description copied from class: AbstractAutoCompleteAdaptor

Returns the number of items in the list.

Specified by:

getItemCount in class AbstractAutoCompleteAdaptor

Returns:

the number of items in the list

getItem

public java.lang.Object getItem(int index)

Description copied from class: AbstractAutoCompleteAdaptor

Returns the item at a given index. It is supposed that 0<=index<getItemCount().

Specified by:

getItem in class AbstractAutoCompleteAdaptor

Parameters:

index - the index of the item that is to be returned

Returns:

the item at the given index

setSelectedItem

public void setSelectedItem(java.lang.Object item)

Description copied from class: AbstractAutoCompleteAdaptor

Sets the selected item.

Specified by:

setSelectedItem in class AbstractAutoCompleteAdaptor

Parameters:

item - the item that is to be selected

getTextComponent

public javax.swing.text.JTextComponent getTextComponent()

Description copied from class: AbstractAutoCompleteAdaptor

Returns the text component that is being used for the automatic completion.

Specified by:

getTextComponent in class AbstractAutoCompleteAdaptor

Returns:

the text component being used for the automatic completion