Package docking.widgets

Class DefaultDropDownSelectionDataModel<T>

java.lang.Object

docking.widgets.DefaultDropDownSelectionDataModel<T>

All Implemented Interfaces:

DropDownTextFieldDataModel<T>

public class DefaultDropDownSelectionDataModel<T>
extends java.lang.Object
implements DropDownTextFieldDataModel<T>

Field Summary

Fields

Change	Modifier and Type	Field	Description
NEW	protected java.util.List<T>	data

Constructor Summary

Constructors

Change	Constructor	Description
DefaultDropDownSelectionDataModel(java.util.List<T> data, DataToStringConverter<T> searchConverter)
DefaultDropDownSelectionDataModel(java.util.List<T> data, DataToStringConverter<T> searchConverter, DataToStringConverter<T> descriptionConverter)

Method Summary

Change	Modifier and Type	Method	Description
	java.lang.String	getDescription(T value)	Returns a description for this item that gives that will be displayed along side of the DropDownSelectionTextField's matching window.
	java.lang.String	getDisplayText(T value)	Returns the text for the given item that will be entered into the DropDownSelectionTextField when the user makes a selection.
	int	getIndexOfFirstMatchingEntry(java.util.List<T> list, java.lang.String text)	Returns the index in the given list of the first item that matches the given text.
	javax.swing.ListCellRenderer<T>	getListRenderer()	Returns the renderer to be used to paint the contents of the list returned by DropDownTextFieldDataModel.getMatchingData(String).
	java.util.List<T>	getMatchingData(java.lang.String searchText)	Returns a list of data that matches the given searchText.
	static DefaultDropDownSelectionDataModel<java.lang.String>	getStringModel(java.util.List<java.lang.String> strings)

Methods inherited from class java.lang.Object

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

Field Detail

data NEW

protected java.util.List<T> data

Constructor Detail

DefaultDropDownSelectionDataModel

public DefaultDropDownSelectionDataModel(java.util.List<T> data,
                                         DataToStringConverter<T> searchConverter)

DefaultDropDownSelectionDataModel

public DefaultDropDownSelectionDataModel(java.util.List<T> data,
                                         DataToStringConverter<T> searchConverter,
                                         DataToStringConverter<T> descriptionConverter)

Method Detail

getStringModel

public static DefaultDropDownSelectionDataModel<java.lang.String> getStringModel(java.util.List<java.lang.String> strings)

getMatchingData

public java.util.List<T> getMatchingData(java.lang.String searchText)

Description copied from interface: DropDownTextFieldDataModel

Returns a list of data that matches the given searchText. A match typically means a "startsWith" match. A list is returned to allow for multiple matches.

Specified by:

getMatchingData in interface DropDownTextFieldDataModel<T>

Parameters:

searchText - The text used to find matches.

Returns:

a list of items matching the given text.

getIndexOfFirstMatchingEntry

public int getIndexOfFirstMatchingEntry(java.util.List<T> list,
                                        java.lang.String text)

Description copied from interface: DropDownTextFieldDataModel

Returns the index in the given list of the first item that matches the given text. For data sets that do not allow duplicates, this is simply the index of the item that matches the text in the list. For items that allow duplicates, the is the index of the first match.

Specified by:

getIndexOfFirstMatchingEntry in interface DropDownTextFieldDataModel<T>

Parameters:

list - the list to search

text - the text to match against the items in the list

Returns:

the index in the given list of the first item that matches the given text.

getListRenderer

public javax.swing.ListCellRenderer<T> getListRenderer()

Description copied from interface: DropDownTextFieldDataModel

Returns the renderer to be used to paint the contents of the list returned by DropDownTextFieldDataModel.getMatchingData(String).

Specified by:

getListRenderer in interface DropDownTextFieldDataModel<T>

getDescription

public java.lang.String getDescription(T value)

Description copied from interface: DropDownTextFieldDataModel

Returns a description for this item that gives that will be displayed along side of the DropDownSelectionTextField's matching window.

Specified by:

getDescription in interface DropDownTextFieldDataModel<T>

getDisplayText

public java.lang.String getDisplayText(T value)

Description copied from interface: DropDownTextFieldDataModel

Returns the text for the given item that will be entered into the DropDownSelectionTextField when the user makes a selection.

Specified by:

getDisplayText in interface DropDownTextFieldDataModel<T>