buoy.widget
Class BCheckBoxMenuItem

java.lang.Object
  extended by buoy.event.EventSource
      extended by buoy.widget.Widget
          extended by buoy.widget.BMenuItem
              extended by buoy.widget.BCheckBoxMenuItem
All Implemented Interfaces:
MenuWidget

public class BCheckBoxMenuItem
extends BMenuItem

A BCheckBoxMenuItem is a menu item for making simple boolean selectons. Selecting it toggles it on and off.

In addition to the event types generated by all Widgets, BCheckBoxMenuItems generate the following event types:

Author:
Peter Eastman

Constructor Summary
BCheckBoxMenuItem()
          Create a new BCheckBoxMenuItem with no label, which is initially deselected.
BCheckBoxMenuItem(java.lang.String text, boolean state)
          Create a new BCheckBoxMenuItem.
BCheckBoxMenuItem(java.lang.String text, javax.swing.Icon image, boolean state)
          Create a new BCheckBoxMenuItem.
BCheckBoxMenuItem(java.lang.String text, Shortcut shortcut, boolean state)
          Create a new BCheckBoxMenuItem.
BCheckBoxMenuItem(java.lang.String text, Shortcut shortcut, javax.swing.Icon image, boolean state)
          Create a new BCheckBoxMenuItem.
 
Method Summary
 javax.swing.JMenuItem getComponent()
          Get the java.awt.Component corresponding to this Widget.
 boolean getState()
          Get the selection state of this menu item.
 void setState(boolean selected)
          Set the selection state of this menu item.
 
Methods inherited from class buoy.widget.BMenuItem
getActionCommand, getIcon, getMnemonic, getShortcut, getText, setActionCommand, setIcon, setMnemonic, setShortcut, setText
 
Methods inherited from class buoy.widget.Widget
addEventLink, dispatchEvent, getBackground, getBounds, getCursor, getFont, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, hasFocus, isEnabled, isFocusable, isVisible, repaint, requestFocus, setBackground, setCursor, setEnabled, setFocusable, setFont, setName, setVisible
 
Methods inherited from class buoy.event.EventSource
addEventLink, addEventLink, removeEventLink
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BCheckBoxMenuItem

public BCheckBoxMenuItem()
Create a new BCheckBoxMenuItem with no label, which is initially deselected.


BCheckBoxMenuItem

public BCheckBoxMenuItem(java.lang.String text,
                         boolean state)
Create a new BCheckBoxMenuItem.

Parameters:
text - the text to display on the BCheckBoxMenuItem
state - the initial selection state of the BCheckBoxMenuItem

BCheckBoxMenuItem

public BCheckBoxMenuItem(java.lang.String text,
                         javax.swing.Icon image,
                         boolean state)
Create a new BCheckBoxMenuItem.

Parameters:
text - the text to display on the BCheckBoxMenuItem
image - the image to display next to the menu item
state - the initial selection state of the BCheckBoxMenuItem

BCheckBoxMenuItem

public BCheckBoxMenuItem(java.lang.String text,
                         Shortcut shortcut,
                         boolean state)
Create a new BCheckBoxMenuItem.

Parameters:
text - the text to display on the BCheckBoxMenuItem
shortcut - a keyboard shortcut which will activate this menu item
state - the initial selection state of the BCheckBoxMenuItem

BCheckBoxMenuItem

public BCheckBoxMenuItem(java.lang.String text,
                         Shortcut shortcut,
                         javax.swing.Icon image,
                         boolean state)
Create a new BCheckBoxMenuItem.

Parameters:
text - the text to display on the BCheckBoxMenuItem
shortcut - a keyboard shortcut which will activate this menu item
image - the image to display next to the menu item
state - the initial selection state of the BCheckBoxMenuItem
Method Detail

getComponent

public javax.swing.JMenuItem getComponent()
Description copied from class: Widget
Get the java.awt.Component corresponding to this Widget.

Overrides:
getComponent in class BMenuItem

getState

public boolean getState()
Get the selection state of this menu item.


setState

public void setState(boolean selected)
Set the selection state of this menu item.



Written by Peter Eastman.