java.awt

Class Choice

public class Choice extends Component implements ItemSelectable, Serializable, Accessible

This class implements a drop down choice list.

Nested Class Summary
protected class	Choice.AccessibleAWTChoice This class provides accessibility support for the combo box.

Constructor Summary
	Choice() Initializes a new instance of `Choice`.

Method Summary
void	add(String item) Adds the specified item to this choice box.
void	addItem(String item) Adds the specified item to this choice box.
void	addItemListener(ItemListener listener) Adds the specified listener to the list of registered listeners for this object.
void	addNotify() Creates the native peer for this object.
int	countItems() Returns the number of items in the list.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this `Choice`.
String	getItem(int index) Returns the item at the specified index in the list.
int	getItemCount() Returns the number of items in the list.
ItemListener[]	getItemListeners() Returns all registered item listeners.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as FooListeners upon this Choice.
int	getSelectedIndex() Returns the index of the selected item.
String	getSelectedItem() Returns the currently selected item, or null if no item is selected.
Object[]	getSelectedObjects() Returns an array with one row containing the selected item.
void	insert(String item, int index) Inserts an item into this Choice.
protected String	paramString() Returns a debugging string for this object.
protected void	processEvent(AWTEvent event) Processes this event by invoking `processItemEvent()` if the event is an instance of `ItemEvent`, otherwise the event is passed to the superclass.
protected void	processItemEvent(ItemEvent event) Processes item event by dispatching to any registered listeners.
void	remove(String item) Removes the specified item from the choice box.
void	remove(int index) Removes the item at the specified index from the choice box.
void	removeAll() Removes all of the objects from this choice box.
void	removeItemListener(ItemListener listener) Removes the specified listener from the list of registered listeners for this object.
void	select(int index) Forces the item at the specified index to be selected.
void	select(String item) Forces the named item to be selected.

Constructor Detail

Choice

public Choice()

Initializes a new instance of Choice.

Throws: HeadlessException If GraphicsEnvironment.isHeadless() returns true

Method Detail

add

public void add(String item)

Adds the specified item to this choice box.

Parameters: item The item to add.

Throws: NullPointerException If the item's value is null

Since: 1.1

addItem

public void addItem(String item)

Adds the specified item to this choice box. This method is oboslete since Java 2 platform 1.1. Please use {@link #add(String)} instead.

Parameters: item The item to add.

Throws: NullPointerException If the item's value is equal to null

addItemListener

public void addItemListener(ItemListener listener)

Adds the specified listener to the list of registered listeners for this object.

Parameters: listener The listener to add.

addNotify

public void addNotify()

Creates the native peer for this object.

countItems

public int countItems()

Deprecated: This method is deprecated in favor of getItemCount.

Returns the number of items in the list.

Returns: The number of items in the list.

getAccessibleContext

public AccessibleContext getAccessibleContext()

Gets the AccessibleContext associated with this Choice. The context is created, if necessary.

Returns: the associated context

getItem

public String getItem(int index)

Returns the item at the specified index in the list.

Parameters: index The index into the list to return the item from.

Throws: ArrayIndexOutOfBoundsException If the index is invalid.

getItemCount

public int getItemCount()

Returns the number of items in the list.

Returns: The number of items in the list.

getItemListeners

public ItemListener[] getItemListeners()

Returns all registered item listeners.

Since: 1.4

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)

Returns an array of all the objects currently registered as FooListeners upon this Choice. FooListeners are registered using the addFooListener method.

Throws: ClassCastException If listenerType doesn't specify a class or interface that implements java.util.EventListener.

Since: 1.3

getSelectedIndex

public int getSelectedIndex()

Returns the index of the selected item.

Returns: The index of the selected item.

getSelectedItem

public String getSelectedItem()

Returns the currently selected item, or null if no item is selected.

Returns: The currently selected item.

getSelectedObjects

public Object[] getSelectedObjects()

Returns an array with one row containing the selected item.

Returns: An array containing the selected item.

insert

public void insert(String item, int index)

Inserts an item into this Choice. Existing items are shifted upwards. If the new item is the only item, then it is selected. If the currently selected item is shifted, then the first item is selected. If the currently selected item is not shifted, then it remains selected.

Parameters: item The item to add. index The index at which the item should be inserted.

Throws: IllegalArgumentException If index is less than 0