java.awt

Class CheckboxMenuItem

Implemented Interfaces:
Accessible, ItemSelectable, Serializable

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.
See Also:
Serialized Form

Nested Class Summary

protected class
CheckboxMenuItem.AccessibleAWTCheckboxMenuItem

Nested classes/interfaces inherited from class java.awt.MenuItem

MenuItem.AccessibleAWTMenuItem

Nested classes/interfaces inherited from class java.awt.MenuComponent

MenuComponent.AccessibleAWTMenuComponent

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
extends EventListener> T[] getListeners(Class listenerType)
Returns an array of all the objects currently registered as FooListeners upon this CheckboxMenuItem.
AccessibleContext
getAccessibleContext()
Gets the AccessibleContext associated with this CheckboxMenuItem.
ItemListener[]
getItemListeners()
Returns an aray of all item listeners currently registered to 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.

Methods inherited from class java.awt.MenuItem

addActionListener, addNotify, deleteShortcut, disable, disableEvents, enable, enable, enableEvents, extends EventListener> T[] getListeners, getAccessibleContext, getActionCommand, getActionListeners, getLabel, getShortcut, isEnabled, paramString, processActionEvent, processEvent, removeActionListener, setActionCommand, setEnabled, setLabel, setShortcut

Methods inherited from class java.awt.MenuComponent

dispatchEvent, getAccessibleContext, getFont, getName, getParent, getPeer, getTreeLock, paramString, postEvent, processEvent, removeNotify, setFont, setName, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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 Details

addItemListener

public void addItemListener(ItemListener listener)
Adds the specified listener to the list of registered item listeners for this object.
Specified by:
addItemListener in interface ItemSelectable
Parameters:
listener - The listener to add.

addNotify

public void addNotify()
Create's this object's native peer
Overrides:
addNotify in interface MenuItem

extends EventListener> T[] getListeners

public extends EventListener> T[] getListeners(Class listenerType)
Returns an array of all the objects currently registered as FooListeners upon this CheckboxMenuItem. FooListeners are registered using the addFooListener method.
Overrides:
extends EventListener> T[] getListeners in interface MenuItem
Throws:
ClassCastException - If listenerType doesn't specify a class or interface that implements java.util.EventListener.

getAccessibleContext

public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this CheckboxMenuItem. The context is created, if necessary.
Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in interface MenuItem
Returns:
the associated context

getItemListeners

public ItemListener[] getItemListeners()
Returns an aray of all item listeners currently registered to this CheckBoxMenuItem.

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.
Specified by:
getSelectedObjects in interface ItemSelectable
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.
Overrides:
paramString in interface MenuItem
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.
Overrides:
processEvent in interface MenuItem
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.
Specified by:
removeItemListener in interface ItemSelectable
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.

CheckboxMenuItem.java -- A menu option with a checkbox on it. Copyright (C) 1999, 2000, 2001, 2002, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.