java.awt

Class CheckboxMenuItem

public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Accessible

This class implements a menu item that has a checkbox on it indicating the selected state of some option.

Nested Class Summary
protected class	CheckboxMenuItem.AccessibleAWTCheckboxMenuItem

Constructor Summary
	CheckboxMenuItem() Initializes a new instance of `CheckboxMenuItem` with no label and an initial state of off.
	CheckboxMenuItem(String label) Initializes a new instance of `CheckboxMenuItem` with the specified label and an initial state of off.
	CheckboxMenuItem(String label, boolean state) Initializes a new instance of `CheckboxMenuItem` with the specified label and initial state.

Method Summary
void	addItemListener(ItemListener listener) Adds the specified listener to the list of registered item listeners for this object.
void	addNotify() Create's this object's native peer
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this `CheckboxMenuItem`.
ItemListener[]	getItemListeners() Returns an aray of all item listeners currently registered to this `CheckBoxMenuItem`.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as FooListeners upon this `CheckboxMenuItem`.
Object[]	getSelectedObjects() Returns an array of length 1 with the menu item label for this object if the state is on.
boolean	getState() Returns the state of this menu item.
String	paramString() Returns a debugging string for this object.
protected void	processEvent(AWTEvent event) Processes the specified event by calling `processItemEvent()` if it is an instance of `ItemEvent` or calling the superclass method otherwise.
protected void	processItemEvent(ItemEvent event) Processes the specified event by dispatching it to any registered listeners.
void	removeItemListener(ItemListener listener) Removes the specified listener from the list of registered item listeners for this object.
void	setState(boolean state) Sets the state of this menu item.

Constructor Detail

CheckboxMenuItem

public CheckboxMenuItem()

Initializes a new instance of CheckboxMenuItem with no label and an initial state of off.

Throws: HeadlessException If GraphicsEnvironment.isHeadless() returns true.

CheckboxMenuItem

public CheckboxMenuItem(String label)

Initializes a new instance of CheckboxMenuItem with the specified label and an initial state of off.

Parameters: label The label of the menu item.

Throws: HeadlessException If GraphicsEnvironment.isHeadless() returns true.

CheckboxMenuItem

public CheckboxMenuItem(String label, boolean state)

Initializes a new instance of CheckboxMenuItem with the specified label and initial state.

Parameters: label The label of the menu item. state The initial state of the menu item, where true is on, and false is off.

Throws: HeadlessException If GraphicsEnvironment.isHeadless() returns true.

Method Detail

addItemListener

public void addItemListener(ItemListener listener)

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

Parameters: listener The listener to add.

addNotify

public void addNotify()

Create's this object's native peer

getAccessibleContext

public AccessibleContext getAccessibleContext()

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

Returns: the associated context

getItemListeners

public ItemListener[] getItemListeners()

Returns an aray of all item listeners currently registered to this CheckBoxMenuItem.

getListeners

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

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

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

getSelectedObjects

public Object[] getSelectedObjects()

Returns an array of length 1 with the menu item label for this object if the state is on. Otherwise null is returned.

Returns: An array with this menu item's label if it has a state of on, or null otherwise.

getState

public boolean getState()

Returns the state of this menu item.

Returns: The state of this menu item.

paramString

public String paramString()

Returns a debugging string for this object.

Returns: A debugging string for this object.

processEvent

protected void processEvent(AWTEvent event)

Processes the specified event by calling processItemEvent() if it is an instance of ItemEvent or calling the superclass method otherwise.

Parameters: event The event to process.

processItemEvent

protected void processItemEvent(ItemEvent event)

Processes the specified event by dispatching it to any registered listeners.

Parameters: event The event to process.

removeItemListener

public void removeItemListener(ItemListener listener)

Removes the specified listener from the list of registered item listeners for this object.

Parameters: listener The listener to remove.

setState

public void setState(boolean state)

Sets the state of this menu item.

Parameters: state The initial state of the menu item, where true is on, and false is off.