| java.lang.Object
 com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.FocusWidget
com.google.gwt.user.client.ui.ListBox
| ListBox | | public class ListBox extends FocusWidget implements SourcesChangeEvents,HasName(Code) | | A widget that presents a list of choices to the user, either as a list box or
as a drop-down list.
CSS Style Rules
Example
|
| Constructor Summary | |
| public | ListBox()
Creates an empty list box in single selection mode. | | public | ListBox(boolean isMultipleSelect)
Creates an empty list box. |
| Method Summary | |
| public void | addChangeListener(ChangeListener listener)
| | public void | addItem(String item)
Adds an item to the list box. | | public void | addItem(String item, String value)
Adds an item to the list box, specifying an initial value for the item. | | public void | clear()
Removes all items from the list box. | | public int | getItemCount()
Gets the number of items present in the list box. | | public String | getItemText(int index)
Gets the text associated with the item at the specified index. | | public String | getName()
| | public int | getSelectedIndex()
Gets the currently-selected item. | | public String | getValue(int index)
Gets the value associated with the item at a given index. | | public int | getVisibleItemCount()
Gets the number of items that are visible. | | public void | insertItem(String item, int index)
Inserts an item into the list box. | | public void | insertItem(String item, String value, int index)
Inserts an item into the list box, specifying an initial value for the
item. | | public boolean | isItemSelected(int index)
Determines whether an individual list item is selected. | | public boolean | isMultipleSelect()
Gets whether this list allows multiple selection. | | public void | onBrowserEvent(Event event)
| | public void | removeChangeListener(ChangeListener listener)
| | public void | removeItem(int index)
Removes the item at the specified index. | | public void | setItemSelected(int index, boolean selected)
Sets whether an individual list item is selected. | | public void | setItemText(int index, String text)
Sets the text associated with the item at a given index. | | public void | setMultipleSelect(boolean multiple)
Sets whether this list allows multiple selections. | | public void | setName(String name)
| | public void | setSelectedIndex(int index)
Sets the currently selected index.
After calling this method, only the specified item in the list will
remain selected. | | public void | setValue(int index, String value)
Sets the value associated with the item at a given index. | | public void | setVisibleItemCount(int visibleItems)
Sets the number of items that are visible. |
| ListBox | | public ListBox()(Code) | | Creates an empty list box in single selection mode.
|
| ListBox | | public ListBox(boolean isMultipleSelect)(Code) | | Creates an empty list box. The preferred way to enable multiple selections
is to use this constructor rather than
ListBox.setMultipleSelect(boolean) .
Parameters:
isMultipleSelect - specifies if multiple selection is enabled |
| addItem | | public void addItem(String item)(Code) | | Adds an item to the list box. This method has the same effect as
addItem(item, item)
Parameters:
item - the text of the item to be added |
| addItem | | public void addItem(String item, String value)(Code) | | Adds an item to the list box, specifying an initial value for the item.
Parameters:
item - the text of the item to be added
Parameters:
value - the item's value, to be submitted if it is part of aFormPanel; cannot be null |
| clear | | public void clear()(Code) | | Removes all items from the list box.
|
| getItemCount | | public int getItemCount()(Code) | | Gets the number of items present in the list box.
the number of items |
| getItemText | | public String getItemText(int index)(Code) | | Gets the text associated with the item at the specified index.
Parameters:
index - the index of the item whose text is to be retrieved the text associated with the item
throws:
IndexOutOfBoundsException - if the index is out of range |
| getSelectedIndex | | public int getSelectedIndex()(Code) | | Gets the currently-selected item. If multiple items are selected, this
method will return the first selected item (
ListBox.isItemSelected(int) can be used to query individual items).
the selected index, or -1 if none is selected |
| getValue | | public String getValue(int index)(Code) | | Gets the value associated with the item at a given index.
Parameters:
index - the index of the item to be retrieved the item's associated value
throws:
IndexOutOfBoundsException - if the index is out of range |
| getVisibleItemCount | | public int getVisibleItemCount()(Code) | | Gets the number of items that are visible. If only one item is visible,
then the box will be displayed as a drop-down list.
the visible item count |
| insertItem | | public void insertItem(String item, int index)(Code) | | Inserts an item into the list box. Has the same effect as
insertItem(item, item, index)
Parameters:
item - the text of the item to be inserted
Parameters:
index - the index at which to insert it |
| insertItem | | public void insertItem(String item, String value, int index)(Code) | | Inserts an item into the list box, specifying an initial value for the
item. If the index is less than zero, or greater than or equal to
the length of the list, then the item will be appended to the end of
the list.
Parameters:
item - the text of the item to be inserted
Parameters:
value - the item's value, to be submitted if it is part of aFormPanel.
Parameters:
index - the index at which to insert it |
| isItemSelected | | public boolean isItemSelected(int index)(Code) | | Determines whether an individual list item is selected.
Parameters:
index - the index of the item to be tested true if the item is selected
throws:
IndexOutOfBoundsException - if the index is out of range |
| isMultipleSelect | | public boolean isMultipleSelect()(Code) | | Gets whether this list allows multiple selection.
true if multiple selection is allowed |
| onBrowserEvent | | public void onBrowserEvent(Event event)(Code) | | |
| removeItem | | public void removeItem(int index)(Code) | | Removes the item at the specified index.
Parameters:
index - the index of the item to be removed
throws:
IndexOutOfBoundsException - if the index is out of range |
| setItemSelected | | public void setItemSelected(int index, boolean selected)(Code) | | Sets whether an individual list item is selected.
Note that setting the selection programmatically does not cause
the
ChangeListener.onChange(Widget) event to be fired.
Parameters:
index - the index of the item to be selected or unselected
Parameters:
selected - true to select the item
throws:
IndexOutOfBoundsException - if the index is out of range |
| setItemText | | public void setItemText(int index, String text)(Code) | | Sets the text associated with the item at a given index.
Parameters:
index - the index of the item to be set
Parameters:
text - the item's new text
throws:
IndexOutOfBoundsException - if the index is out of range |
| setMultipleSelect | | public void setMultipleSelect(boolean multiple)(Code) | | Sets whether this list allows multiple selections. NOTE: The preferred
way of enabling multiple selections in a list box is by using the
ListBox.ListBox(boolean) constructor. Using this method can spuriously
fail on Internet Explorer 6.0.
Parameters:
multiple - true to allow multiple selections |
| setSelectedIndex | | public void setSelectedIndex(int index)(Code) | | Sets the currently selected index.
After calling this method, only the specified item in the list will
remain selected. For a ListBox with multiple selection enabled, see
ListBox.setItemSelected(int,boolean) to select multiple items at a time.
Note that setting the selected index programmatically does not
cause the
ChangeListener.onChange(Widget) event to be fired.
Parameters:
index - the index of the item to be selected |
| setValue | | public void setValue(int index, String value)(Code) | | Sets the value associated with the item at a given index. This value can be
used for any purpose, but is also what is passed to the server when the
list box is submitted as part of a
FormPanel .
Parameters:
index - the index of the item to be set
Parameters:
value - the item's new value; cannot be null
throws:
IndexOutOfBoundsException - if the index is out of range |
| setVisibleItemCount | | public void setVisibleItemCount(int visibleItems)(Code) | | Sets the number of items that are visible. If only one item is visible,
then the box will be displayed as a drop-down list.
Parameters:
visibleItems - the visible item count |
|
|