com.ur.urcap.api.ui.component

Interface SelectList

All Superinterfaces:

HTMLComponent

public interface SelectList
extends HTMLComponent

Represents a selection list UI component.

The implementation of the list have special rules and rendering for Variable objects. Unregistered variables are not visible nor selectable (until they become registered).

Note: For unresolved PolyScope entities, like Features, Variables and TCPs, that are selected in the list, the item will be highlighted with a yellow border.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
void	addAllItems(List<?> items)
void	addItem(Object item)
void	clearSelection() unselect currently selected item(s).
int	getItemCount()
Object[]	getItems()
int	getSelectedIndex()
int[]	getSelectedIndices()
Object	getSelectedItem()
Object[]	getSelectedItems()
void	refresh() Update the rendering of the list element.
void	removeAllItems() Remove all items.
void	removeItem(Object item)
void	selectItems(Object... item)
void	selectItemsAtIndices(int... indices)
void	setItems(List<?> items)

Methods inherited from interface com.ur.urcap.api.ui.component.HTMLComponent

isEnabled, isVisible, setEnabled, setVisible

Method Detail

setItems

void setItems(List<?> items)

Parameters:

items - clear the current items and set the list of items to items.

addItem

void addItem(Object item)

Parameters:

item - add a new item to the drop down.

addAllItems

void addAllItems(List<?> items)

Parameters:

items - add the list of items.

removeItem

void removeItem(Object item)

Parameters:

item - remove item.

removeAllItems

void removeAllItems()

Remove all items.

clearSelection

void clearSelection()

unselect currently selected item(s).

selectItems

void selectItems(Object... item)

Parameters:

item - select the items.

selectItemsAtIndices

void selectItemsAtIndices(int... indices)

Parameters:

indices - select the items at indices. The first element is at index 0.

getItemCount

int getItemCount()

Returns:

the number of items in the list.

getSelectedItems

Object[] getSelectedItems()

Returns:

list of selected items.

getSelectedItem

Object getSelectedItem()

Returns:

Returns the value for the smallest selected cell index; the selected value when only a single item is selected in the list. When multiple items are selected, it is simply the value for the smallest selected index. Returns null if there is no selection.

getSelectedIndex

int getSelectedIndex()

Returns:

Returns the smallest selected cell index; the selection when only a single item is selected in the list. When multiple items are selected, it is simply the smallest selected index. Returns -1 if there is no selection.

getSelectedIndices

int[] getSelectedIndices()

Returns:

all of the selected indices, in increasing order, or an empty array if nothing is selected.

getItems

Object[] getItems()

Returns:

the objects in the list.

refresh

void refresh()

Update the rendering of the list element.