javax.swing
Class JCheckBoxMenuItem

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.AbstractButton
                          |
                          +--javax.swing.JMenuItem
                                |
                                +--javax.swing.JCheckBoxMenuItem
public class JCheckBoxMenuItem
extends javax.swing.JMenuItem
implements javax.swing.SwingConstants, javax.accessibility.Accessible

A menu item that can be selected or deselected. If selected, the menu item typically appears with a checkmark next to it. If unselected or deselected, the menu item appears without a checkmark. Like a regular menu item, a checkbox menu item can have either text or a graphic icon associated with it, or both.

Either isSelected/setSelected or getState/setState can be used to determine/specify the menu item's selection state. (The Swing-standard methods are isSelected and setSelected. These methods work for all menus and buttons. The getState and setState methods exist for compatibility with other component sets.)

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JCheckBoxMenuItem key assignments.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. A future release of Swing will provide support for long term persistence.

Author:
Georges Saab, David Karlton
See Also:
Serialized Form

Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Fields inherited from class javax.swing.AbstractButton
BORDER_PAINTED_CHANGED_PROPERTY, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Constructor Summary
JCheckBoxMenuItem()
          Creates an initially unselected checkboxMenuItem with no set text or icon.
JCheckBoxMenuItem(javax.swing.Icon icon)
          Creates an initially unselected checkboxMenuItem with an icon.
JCheckBoxMenuItem(java.lang.String text)
          Creates an initially unselected checkboxMenuItem with text.
JCheckBoxMenuItem(java.lang.String text, boolean b)
          Creates a checkboxMenuItem with the specified text and selection state.
JCheckBoxMenuItem(java.lang.String text, javax.swing.Icon icon)
          Creates an initially unselected checkboxMenuItem with the specified text and icon.
JCheckBoxMenuItem(java.lang.String text, javax.swing.Icon icon, boolean b)
          Creates a checkboxMenuItem with the specified text, icon, and selection state.
 
Method Summary
 javax.accessibility.AccessibleContext getAccessibleContext()
          Get the AccessibleContext associated with this JComponent
 java.lang.Object[] getSelectedObjects()
          Returns an array (length 1) containing the checkbox menu item label or null if the checkbox is not selected.
 boolean getState()
          Returns the selected-state of the item.
 java.lang.String getUIClassID()
          Returns the name of the L&F class that renders this component.
 void requestFocus()
          Override JComponent.requestFocus() to prevent grabbing the focus.
 void setState(boolean b)
          Sets the selected-state of the item.
 void updateUI()
          Notification from the UIFactory that the L&F has changed.
 
Methods inherited from class javax.swing.JMenuItem
addMenuDragMouseListener, addMenuKeyListener, getAccelerator, getComponent, getSubElements, isArmed, menuSelectionChanged, processKeyEvent, processMenuDragMouseEvent, processMenuKeyEvent, processMouseEvent, removeMenuDragMouseListener, removeMenuKeyListener, setAccelerator, setArmed, setEnabled, setUI
 
Methods inherited from class javax.swing.AbstractButton
addActionListener, addChangeListener, addItemListener, doClick, doClick, getActionCommand, getDisabledIcon, getDisabledSelectedIcon, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getLabel, getMargin, getMnemonic, getModel, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getText, getUI, getVerticalAlignment, getVerticalTextPosition, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, removeActionListener, removeChangeListener, removeItemListener, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setLabel, setMargin, setMnemonic, setMnemonic, setModel, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, remove, removeAll, removeContainerListener, setLayout, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, bounds, checkImage, checkImage, contains, createImage, createImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JCheckBoxMenuItem

public JCheckBoxMenuItem()
Creates an initially unselected checkboxMenuItem with no set text or icon.

JCheckBoxMenuItem

public JCheckBoxMenuItem(javax.swing.Icon icon)
Creates an initially unselected checkboxMenuItem with an icon.
Parameters:
icon - the icon of the CheckBoxMenuItem.

JCheckBoxMenuItem

public JCheckBoxMenuItem(java.lang.String text)
Creates an initially unselected checkboxMenuItem with text.
Parameters:
text - the text of the CheckBoxMenuItem

JCheckBoxMenuItem

public JCheckBoxMenuItem(java.lang.String text,
                         javax.swing.Icon icon)
Creates an initially unselected checkboxMenuItem with the specified text and icon.
Parameters:
text - the text of the CheckBoxMenuItem
icon - the icon of the CheckBoxMenuItem

JCheckBoxMenuItem

public JCheckBoxMenuItem(java.lang.String text,
                         boolean b)
Creates a checkboxMenuItem with the specified text and selection state.
Parameters:
text - the text of the CheckBoxMenuItem.
b - the selected state of the checkboxmenuitem

JCheckBoxMenuItem

public JCheckBoxMenuItem(java.lang.String text,
                         javax.swing.Icon icon,
                         boolean b)
Creates a checkboxMenuItem with the specified text, icon, and selection state.
Parameters:
text - the text of the CheckBoxMenuItem
icon - the icon of the CheckBoxMenuItem
b - the selected state of the checkboxmenuitem
Method Detail

updateUI

public void updateUI()
Notification from the UIFactory that the L&F has changed.
Overrides:
updateUI in class javax.swing.JMenuItem
See Also:
JComponent.updateUI()

getUIClassID

public java.lang.String getUIClassID()
Returns the name of the L&F class that renders this component.
Returns:
"CheckBoxMenuItemUI"
Overrides:
getUIClassID in class javax.swing.JMenuItem
See Also:
JComponent.getUIClassID(), UIDefaults#getUI

getState

public boolean getState()
Returns the selected-state of the item. This method exists for AWT compatibility only. New code should use isSelected() instead.
Returns:
true if the item is selected

setState

public void setState(boolean b)
Sets the selected-state of the item. This method exists for AWT compatibility only. New code should use setSelected() instead.
Parameters:
b - a boolean value indicating the item's selected-state, where true=selected

getSelectedObjects

public java.lang.Object[] getSelectedObjects()
Returns an array (length 1) containing the checkbox menu item label or null if the checkbox is not selected.
Returns:
an array containing 1 Object -- the text of the menu item -- if the item is selected, otherwise null
Overrides:
getSelectedObjects in class javax.swing.AbstractButton

requestFocus

public void requestFocus()
Override JComponent.requestFocus() to prevent grabbing the focus.
Overrides:
requestFocus in class javax.swing.JComponent

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()
Get the AccessibleContext associated with this JComponent
Specified by:
getAccessibleContext in interface javax.accessibility.Accessible
Returns:
the AccessibleContext of this JComponent
Overrides:
getAccessibleContext in class javax.swing.JMenuItem