Package org.jdesktop.swingx.autocomplete

Class ListAdaptor

java.lang.Object

org.jdesktop.swingx.autocomplete.AbstractAutoCompleteAdaptor

org.jdesktop.swingx.autocomplete.ListAdaptor

All Implemented Interfaces:

java.util.EventListener, javax.swing.event.ListSelectionListener

public class ListAdaptor
extends AbstractAutoCompleteAdaptor
implements javax.swing.event.ListSelectionListener

An implementation of the AbstractAutoCompleteAdaptor that is suitable for a JList in conjunction with a JTextComponent.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) javax.swing.JList	list	the list containing the items
(package private) ObjectToStringConverter	stringConverter	the converter used to transform items to strings
(package private) javax.swing.text.JTextComponent	textComponent	the text component that is used for automatic completion

Constructor Summary

Constructors

Constructor	Description
ListAdaptor(javax.swing.JList list, javax.swing.text.JTextComponent textComponent)	Creates a new JListAdaptor for the given list and text component.
ListAdaptor(javax.swing.JList list, javax.swing.text.JTextComponent textComponent, ObjectToStringConverter stringConverter)	Creates a new JListAdaptor for the given list and text component.

Method Summary

Modifier and Type	Method	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.
void	valueChanged(javax.swing.event.ListSelectionEvent listSelectionEvent)	Implementation side effect - do not invoke.

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

Field Detail

list

javax.swing.JList list

the list containing the items

textComponent

javax.swing.text.JTextComponent textComponent

the text component that is used for automatic completion

stringConverter

ObjectToStringConverter stringConverter

the converter used to transform items to strings

Constructor Detail

ListAdaptor

public ListAdaptor(javax.swing.JList list,
                   javax.swing.text.JTextComponent textComponent)

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

Parameters:

list - the list that contains the items that are used for automatic completion

textComponent - the text component that will be used automatic completion

ListAdaptor

public ListAdaptor(javax.swing.JList list,
                   javax.swing.text.JTextComponent textComponent,
                   ObjectToStringConverter stringConverter)

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

Parameters:

list - the list that contains the items that are used for automatic completion

textComponent - the text component that will be used automatic completion

stringConverter - the converter used to transform items to strings

Method Detail

valueChanged

public void valueChanged(javax.swing.event.ListSelectionEvent listSelectionEvent)

Implementation side effect - do not invoke.

Specified by:

valueChanged in interface javax.swing.event.ListSelectionListener

Parameters:

listSelectionEvent - -

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