java.awt
Class CheckboxMenuItem

java.lang.Object
  |
  +--java.awt.MenuComponent
        |
        +--java.awt.MenuItem
              |
              +--java.awt.CheckboxMenuItem

All Implemented Interfaces:

Accessible, ItemSelectable, Serializable

public class CheckboxMenuItem

extends MenuItem

implements ItemSelectable, Accessible

Unsafe:

See Also:

Serialized Form

Field Summary

private static String	base
private int	checkboxMenuItemSerializedDataVersion
(package private) ItemListener	itemListener
private static int	nameCounter
private static long	serialVersionUID
(package private) boolean	state The state of a checkbox menu item

Fields inherited from class java.awt.MenuItem

actionCommand, actionListener, enabled, eventMask, label

Fields inherited from class java.awt.MenuComponent

accessibleContext, actionListenerK, appContext, font, itemListenerK, newEventsOnly, parent, peer

Constructor Summary

CheckboxMenuItem()
Suppressed: Create a check box menu item with an empty label.

CheckboxMenuItem(String label)
Suppressed: Create a check box menu item with the specified label.

CheckboxMenuItem(String label, boolean state)
Suppressed: Create a check box menu item with the specified label and state.

Method Summary

void	addItemListener(ItemListener l) Suppressed: Adds the specified item listener to receive item events from this check box menu item.
void	addNotify() Suppressed: Creates the peer of the checkbox item.
(package private) String	constructComponentName() Construct a name for this MenuComponent.
(package private) void	doMenuEvent(long when, int modifiers)
(package private) boolean	eventEnabled(AWTEvent e)
AccessibleContext	getAccessibleContext() Suppressed: Gets the AccessibleContext associated with this CheckboxMenuItem.
ItemListener[]	getItemListeners() Suppressed: Returns an array of all the item listeners registered on this checkbox menuitem.
EventListener[]	getListeners(Class listenerType) Suppressed: Returns an array of all the objects currently registered as FooListeners upon this CheckboxMenuItem.
Object[]	getSelectedObjects() Suppressed: Returns the an array (length 1) containing the checkbox menu item label or null if the checkbox is not selected.
boolean	getState() Suppressed: Determines whether the state of this check box menu item is "on" or "off."
private static void	initIDs() Initialize JNI field and method IDs
String	paramString() Suppressed: Returns a string representing the state of this CheckBoxMenuItem.
protected void	processEvent(AWTEvent e) Processes events on this check box menu item.
protected void	processItemEvent(ItemEvent e) Processes item events occurring on this check box menu item by dispatching them to any registered ItemListener objects.
private void	readObject(ObjectInputStream s) Reads the ObjectInputStream and if it isn't null adds a listener to receive action events fired by the Menu Item.
void	removeItemListener(ItemListener l) Suppressed: Removes the specified item listener so that it no longer receives item events from this check box menu item.
void	setState(boolean b) Suppressed: Sets this check box menu item to the specifed state.
private void	writeObject(ObjectOutputStream s) Writes default serializable fields to stream.

Methods inherited from class java.awt.MenuItem

addActionListener, deleteShortcut, deleteShortcut, disable, disableEvents, enable, enable, enableEvents, getActionCommand, getActionListeners, getLabel, getShortcut, getShortcutMenuItem, handleShortcut, isEnabled, processActionEvent, removeActionListener, setActionCommand, setEnabled, setLabel, setShortcut

Methods inherited from class java.awt.MenuComponent

dispatchEvent, dispatchEventImpl, getAccessibleIndexInParent, getAccessibleStateSet, getFont_NoClientCode, getFont, getName, getParent_NoClientCode, getParent, getPeer, getTreeLock, postEvent, removeNotify, setFont, setName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

state

boolean state

The state of a checkbox menu item

See Also:

getState(), #setState()

itemListener

transient ItemListener itemListener

base

private static final String base

nameCounter

private static int nameCounter

serialVersionUID

private static final long serialVersionUID

checkboxMenuItemSerializedDataVersion

private int checkboxMenuItemSerializedDataVersion

Constructor Detail

CheckboxMenuItem

public CheckboxMenuItem()
                 throws HeadlessException

Suppressed: Create a check box menu item with an empty label. The item's state is initially set to "off."

Since:

JDK1.1

See Also:

java.awt.GraphicsEnvironment#isHeadless

CheckboxMenuItem

public CheckboxMenuItem(String label)
                 throws HeadlessException

Suppressed: Create a check box menu item with the specified label. The item's state is initially set to "off."

Parameters:

label - a string label for the check box menu item, or null for an unlabeled menu item.

See Also:

java.awt.GraphicsEnvironment#isHeadless

CheckboxMenuItem

public CheckboxMenuItem(String label,
                        boolean state)
                 throws HeadlessException

Suppressed: Create a check box menu item with the specified label and state.

Parameters:

label - a string label for the check box menu item, or null for an unlabeled menu item.

state - the initial state of the menu item, where true indicates "on" and false indicates "off."

Since:

JDK1.1

See Also:

java.awt.GraphicsEnvironment#isHeadless

Method Detail

constructComponentName

String constructComponentName()

Construct a name for this MenuComponent. Called by getName() when the name is null.

Overrides:

constructComponentName in class MenuItem

Returns:

a name for this MenuComponent

addNotify

public void addNotify()

Suppressed: Creates the peer of the checkbox item. This peer allows us to change the look of the checkbox item without changing its functionality. Most applications do not call this method directly.

Overrides:

addNotify in class MenuItem

See Also:

java.awt.Toolkit#createCheckboxMenuItem(java.awt.CheckboxMenuItem), java.awt.Component#getToolkit()

getState

public boolean getState()

Suppressed: Determines whether the state of this check box menu item is "on" or "off."

Returns:

the state of this check box menu item, where true indicates "on" and false indicates "off"

See Also:

setState(boolean)

setState

public void setState(boolean b)

Suppressed: Sets this check box menu item to the specifed state. The boolean value true indicates "on" while false indicates "off."

Note that this method should be primarily used to initialize the state of the check box menu item. Programmatically setting the state of the check box menu item will not trigger an ItemEvent. The only way to trigger an ItemEvent is by user interaction.

Parameters:

b - true if the check box menu item is on, otherwise false

See Also:

getState()

getSelectedObjects

public Object[] getSelectedObjects()

Suppressed: Returns the an array (length 1) containing the checkbox menu item label or null if the checkbox is not selected.

Specified by:

getSelectedObjects in interface ItemSelectable

See Also:

ItemSelectable

addItemListener

public void addItemListener(ItemListener l)

Suppressed: Adds the specified item listener to receive item events from this check box menu item. Item events are sent in response to user actions, but not in response to calls to setState(). If l is null, no exception is thrown and no action is performed.

Specified by:

addItemListener in interface ItemSelectable

Parameters:

l - the item listener

Since:

JDK1.1

See Also:

removeItemListener(java.awt.event.ItemListener), getItemListeners(), setState(boolean), java.awt.event.ItemEvent, java.awt.event.ItemListener

removeItemListener

public void removeItemListener(ItemListener l)

Suppressed: Removes the specified item listener so that it no longer receives item events from this check box menu item. If l is null, no exception is thrown and no action is performed.

Specified by:

removeItemListener in interface ItemSelectable

Parameters:

l - the item listener

Since:

JDK1.1

See Also:

addItemListener(java.awt.event.ItemListener), getItemListeners(), java.awt.event.ItemEvent, java.awt.event.ItemListener

getItemListeners

public ItemListener[] getItemListeners()

Suppressed: Returns an array of all the item listeners registered on this checkbox menuitem.

Returns:

all of this checkbox menuitem's ItemListeners or an empty array if no item listeners are currently registered

Since:

1.4

See Also:

addItemListener(java.awt.event.ItemListener), removeItemListener(java.awt.event.ItemListener), java.awt.event.ItemEvent, java.awt.event.ItemListener

getListeners

public EventListener[] getListeners(Class listenerType)

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

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a CheckboxMenuItem c for its item listeners with the following code:

ItemListener[] ils = (ItemListener[])(c.getListeners(ItemListener.class));

If no such listeners exist, this method returns an empty array.

Overrides:

getListeners in class MenuItem

Parameters:

listenerType - the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener

Returns:

an array of all objects registered as FooListeners on this checkbox menuitem, or an empty array if no such listeners have been added

Since:

1.3

See Also:

getItemListeners()

eventEnabled

boolean eventEnabled(AWTEvent e)

Overrides:

eventEnabled in class MenuItem

processEvent

protected void processEvent(AWTEvent e)

Processes events on this check box menu item. If the event is an instance of ItemEvent, this method invokes the processItemEvent method. If the event is not an item event, it invokes processEvent on the superclass.

Check box menu items currently support only item events.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.

Overrides:

processEvent in class MenuItem

Parameters:

e - the event

Since:

JDK1.1

See Also:

java.awt.event.ItemEvent, processItemEvent(java.awt.event.ItemEvent)

processItemEvent

protected void processItemEvent(ItemEvent e)

Processes item events occurring on this check box menu item by dispatching them to any registered ItemListener objects.

This method is not called unless item events are enabled for this menu item. Item events are enabled when one of the following occurs:

• An ItemListener object is registered via addItemListener.
• Item events are enabled via enableEvents.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.

Parameters:

e - the item event

Since:

JDK1.1

See Also:

java.awt.event.ItemEvent, java.awt.event.ItemListener, addItemListener(java.awt.event.ItemListener), java.awt.MenuItem#enableEvents

doMenuEvent

void doMenuEvent(long when,
                 int modifiers)

Overrides:

doMenuEvent in class MenuItem

paramString

public String paramString()

Suppressed: Returns a string representing the state of this CheckBoxMenuItem. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

paramString in class MenuItem

Returns:

the parameter string of this check box menu item

writeObject

private void writeObject(ObjectOutputStream s)
                  throws IOException

Writes default serializable fields to stream. Writes a list of serializable ItemListeners as optional data. The non-serializable ItemListeners are detected and no attempt is made to serialize them.

Parameters:

s - the ObjectOutputStream to write

IOException

See Also:

AWTEventMulticaster.save(ObjectOutputStream, String, EventListener), java.awt.Component.itemListenerK, readObject(java.io.ObjectInputStream)

readObject

private void readObject(ObjectInputStream s)
                 throws ClassNotFoundException,
                        IOException

Description copied from class: MenuItem

Reads the ObjectInputStream and if it isn't null adds a listener to receive action events fired by the Menu Item. Unrecognized keys or values will be ignored.

Parameters:

s - the ObjectInputStream to read

ClassNotFoundException

IOException

See Also:

removeActionListener(), addActionListener(), MenuItem.writeObject(java.io.ObjectOutputStream)

initIDs

private static void initIDs()

Initialize JNI field and method IDs

getAccessibleContext

public AccessibleContext getAccessibleContext()

Suppressed: Gets the AccessibleContext associated with this CheckboxMenuItem. For checkbox menu items, the AccessibleContext takes the form of an AccessibleAWTCheckboxMenuItem. A new AccessibleAWTCheckboxMenuItem is created if necessary.

Specified by:

getAccessibleContext in interface Accessible

Overrides:

getAccessibleContext in class MenuItem

Returns:

an AccessibleAWTCheckboxMenuItem that serves as the AccessibleContext of this CheckboxMenuItem