org.uberfire.ext.widgets.common.client.dropdown

Interface LiveSearchSelectionHandler<TYPE>

Type Parameters:

TYPE - The data type handled by the component

All Known Implementing Classes:

MultipleLiveSearchSelectionHandler, SingleLiveSearchSelectionHandler

public interface LiveSearchSelectionHandler<TYPE>

Handles the selection of a LiveSearchDropDown

Method Summary

Modifier and Type	Method and Description
void	clearSelection() Clears the selection
String	getDropDownMenuHeader() Retrieves the text for the LiveSearchDropDown header based on the selected values
boolean	isMultipleSelection() Determines if the handler supports multiple selection or not.
void	registerItem(LiveSearchSelectorItem<TYPE> item) Registers and initializes the given LiveSearchSelectorItem
void	selectItem(LiveSearchSelectorItem<TYPE> item) Sets the given LiveSearchSelectorItem as a selected value
void	selectKey(TYPE key) Selects the LiveSearchSelectorItem that has the given key
void	setLiveSearchSelectionCallback(Command command) Sets the Command callback to notify the LiveSearchDropDown when there's a selection change.

Method Detail

getDropDownMenuHeader

String getDropDownMenuHeader()

Retrieves the text for the LiveSearchDropDown header based on the selected values

Returns:

The LiveSearchDropDown header

registerItem

void registerItem(LiveSearchSelectorItem<TYPE> item)

Registers and initializes the given LiveSearchSelectorItem

Parameters:

item -

selectItem

void selectItem(LiveSearchSelectorItem<TYPE> item)

Sets the given LiveSearchSelectorItem as a selected value

Parameters:

item -

selectKey

void selectKey(TYPE key)

Selects the LiveSearchSelectorItem that has the given key

Parameters:

key -

clearSelection

void clearSelection()

Clears the selection

setLiveSearchSelectionCallback

void setLiveSearchSelectionCallback(Command command)

Sets the Command callback to notify the LiveSearchDropDown when there's a selection change.

Parameters:

command -

isMultipleSelection

boolean isMultipleSelection()

Determines if the handler supports multiple selection or not.

Returns:

True if supports multiple selection, false if not.