com.ur.urcap.api.ui.component

Interface SelectDropDownList

All Superinterfaces:

HTMLComponent

public interface SelectDropDownList
extends HTMLComponent

Represents a select list (drop down style) UI component.

The implementation of the drop-down 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 drop-down list, the item will be highlighted with a yellow border.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
void	addItem(Object item)
int	getItemCount()
int	getSelectedIndex()
Object	getSelectedItem()
void	removeAllItems() Remove all items.
void	selectItem(Object item)
void	selectItemAtIndex(int index)
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.

removeAllItems

void removeAllItems()

Remove all items.

getItemCount

int getItemCount()

Returns:

the number of items in the drop down.

getSelectedItem

Object getSelectedItem()

Returns:

the currently selected item.

getSelectedIndex

int getSelectedIndex()

Returns:

the index of the currently selected item where 0 specifies the first item in the list; or -1 if no item is selected or if the currently selected item is not in the list.

selectItem

void selectItem(Object item)

Parameters:

item - Select the item.

selectItemAtIndex

void selectItemAtIndex(int index)

Parameters:

index - Select the item at index index where 0 specifies the first item.