IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.desktop
Class MenuButton

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.AbstractButton
                  extended byjavax.swing.JButton
                      extended bycom.ibm.dse.gui.SpButton
                          extended bycom.ibm.dse.desktop.MenuButton
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, DesktopComponent, java.util.EventListener, GUIComponent, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.event.KeyListener, java.awt.MenuContainer, PanelActions, java.io.Serializable, javax.swing.SwingConstants

public class MenuButton
extends SpButton
implements DesktopComponent, java.awt.event.ActionListener

The MenuButton class provides a button that represents a menu of items.

See Also:
Serialized Form

Nested Class Summary
(package private)  class MenuButton.MenuButtonL
           
 
Nested classes inherited from class javax.swing.JButton
javax.swing.JButton.AccessibleJButton
 
Nested classes inherited from class javax.swing.AbstractButton
javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected  boolean circularNavigation
          describes the kind of navigation
(package private) static int heightScreen
           
protected  java.lang.String hotKey
          identifier of the hotkey
(package private) static boolean screenSizeComputed
           
(package private) static int widthScreen
           
 
Fields inherited from class javax.swing.AbstractButton
actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, 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, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, 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
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Container
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
MenuButton()
          This constructor creates a MenuButton object.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          Handles events for the ActionListener interface.
 void add(java.lang.Object o)
          Adds a MenuItem or a Separator to the MenuButton.
protected  void doClickPopupMenu(int mnemonic)
          Simulates a mouse click on the menu item containing the mnemonic parameter.
 java.lang.String getHotKey()
          Gets the hotKey of the MenuButton.
 javax.swing.JPopupMenu getPopupMenu()
          Gets the pop-up menu.
 boolean isCircularNavigation()
          Indicates whether to step to the top item button when the user presses the "down arrow" key.
static void main(java.lang.String[] args)
          Provides the main entrypoint.
protected  void menuButton_FocusLost(java.awt.event.FocusEvent e)
          Invoked when the MenuButton loses the focus.
protected  void menuButton_KeyPressed(java.awt.event.KeyEvent keyEvent)
          Invoked when a key is pressed on the MenuButton (or MenuItem).
protected  void menuButton_KeyTyped(java.awt.event.KeyEvent keyEvent)
          Invoked when a key is typed on the MenuButton (or MenuItem).
protected  void menuItem_MouseEntered(java.awt.event.MouseEvent mouseEvent)
          Invoked when the mouse enters or moves on a MenuItem (or Separator).
protected  void navigatePopupMenu(int direction)
          Navigates in the pop-up menu according to the direction parameter value.
 void setCircularNavigation(java.lang.Object o)
          Sets the value that indicates whether to do a circular navigation in the pop-up menu.
 void setComponentOrientation(java.awt.ComponentOrientation o)
          Changes the orientation of the components inside the MenuButton.
 void setHeight(java.lang.Object o)
          Sets the height of the MenuButton.
 void setHotKey(java.lang.Object o)
          Sets the hotkey (keyboard shortcut) of the MenuButton.
 void setIconName(java.lang.Object o)
          Sets the icon of the MenuButton.
 void setName(java.lang.Object o)
          Sets the name of the MenuButton.
 void setOnInitialize(java.lang.Object o)
          Sets the specified Java script code that is executed when the component is initialized.
 void setToolTipText(java.lang.Object o)
          Sets the toolTipText of the MenuButton.
 void setWidth(java.lang.Object o)
          Sets the width of the MenuButton.
 void setX(java.lang.Object o)
          Sets the X coordinate for the location of the MenuButton.
 void setY(java.lang.Object o)
          Sets the Y coordinate for the location of the MenuButton.
protected  void showMenu()
          Shows the MenuButton's pop-up menu in a visible area.
protected  void showMenu(javax.swing.JPopupMenu popup)
          Shows the MenuButton's pop-up menu in a visible area.
 java.lang.String toString()
          Returns a string representation of the MenuButton.
protected  void walkMenu()
          Selects the first item of the MenuButton.
 
Methods inherited from class com.ibm.dse.gui.SpButton
addActionListener, addCoordinatedEventListener, fireCoordinationEvent, fireCoordinationEvent, getActivatedOkKey, getDataToClear, getDisableExecuteButton, getDSECoordinatedPanel, getFollowMandatory, getHelpID, getNavigationParameters, getSpPanel, getType, keyPressed, keyReleased, keyTyped, processComponentKeyEvent, removeCoordinatedEventListener, setActivatedOkKey, setDataToClear, setDisableExecuteButton, setFollowMandatory, setHelpID, setMnemonic, setMnemonic, setNavigationParameters, setType
 
Methods inherited from class javax.swing.JButton
configurePropertiesFromAction, getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, removeNotify, setDefaultCapable, updateUI
 
Methods inherited from class javax.swing.AbstractButton
addChangeListener, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setMargin, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

widthScreen

static int widthScreen

heightScreen

static int heightScreen

screenSizeComputed

static boolean screenSizeComputed

circularNavigation

protected boolean circularNavigation
describes the kind of navigation


hotKey

protected java.lang.String hotKey
identifier of the hotkey

Constructor Detail

MenuButton

public MenuButton()
This constructor creates a MenuButton object.

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Handles events for the ActionListener interface.

Specified by:
actionPerformed in interface java.awt.event.ActionListener
Overrides:
actionPerformed in class SpButton
Parameters:
e - java.awt.event.ActionEvent

add

public void add(java.lang.Object o)
Adds a MenuItem or a Separator to the MenuButton.

Specified by:
add in interface DesktopComponent
Parameters:
o - java.lang.Object

doClickPopupMenu

protected void doClickPopupMenu(int mnemonic)
Simulates a mouse click on the menu item containing the mnemonic parameter.

Parameters:
mnemonic - int

getHotKey

public java.lang.String getHotKey()
Gets the hotKey of the MenuButton.

Returns:
java.lang.String

getPopupMenu

public javax.swing.JPopupMenu getPopupMenu()
Gets the pop-up menu.

Returns:
com.sun.java.swing.JPopupMenu

isCircularNavigation

public boolean isCircularNavigation()
Indicates whether to step to the top item button when the user presses the "down arrow" key. Indicates the same in the reverse order with the "up arrow" key.

Returns:
boolean

main

public static void main(java.lang.String[] args)
Provides the main entrypoint. It starts the part when it is run as an application.

Parameters:
args - java.lang.String[]

menuButton_FocusLost

protected void menuButton_FocusLost(java.awt.event.FocusEvent e)
Invoked when the MenuButton loses the focus.

Hides the pop-up menu corresponding to this MenuButton.


menuButton_KeyPressed

protected void menuButton_KeyPressed(java.awt.event.KeyEvent keyEvent)
Invoked when a key is pressed on the MenuButton (or MenuItem).


menuButton_KeyTyped

protected void menuButton_KeyTyped(java.awt.event.KeyEvent keyEvent)
Invoked when a key is typed on the MenuButton (or MenuItem).

When the letter corresponding to a MenuItem's mnemonic is typed, the MenuItem will be pressed.


menuItem_MouseEntered

protected void menuItem_MouseEntered(java.awt.event.MouseEvent mouseEvent)
Invoked when the mouse enters or moves on a MenuItem (or Separator).

Selects the MenuItem that generates the event.


navigatePopupMenu

protected void navigatePopupMenu(int direction)
Navigates in the pop-up menu according to the direction parameter value.

Parameters:
direction - int

setCircularNavigation

public void setCircularNavigation(java.lang.Object o)
Sets the value that indicates whether to do a circular navigation in the pop-up menu.

Parameters:
o - java.lang.Object

setComponentOrientation

public void setComponentOrientation(java.awt.ComponentOrientation o)
Changes the orientation of the components inside the MenuButton.

Parameters:
o - ComponentOrientation

setHeight

public void setHeight(java.lang.Object o)
Sets the height of the MenuButton.

Parameters:
o - java.lang.Object

setHotKey

public void setHotKey(java.lang.Object o)
Sets the hotkey (keyboard shortcut) of the MenuButton.

Parameters:
o - java.lang.Object

setIconName

public void setIconName(java.lang.Object o)
Sets the icon of the MenuButton.


setName

public void setName(java.lang.Object o)
Sets the name of the MenuButton.

Parameters:
o - java.lang.Object

setOnInitialize

public void setOnInitialize(java.lang.Object o)
Sets the specified Java script code that is executed when the component is initialized.

Parameters:
o - java.lang.Object

setToolTipText

public void setToolTipText(java.lang.Object o)
Sets the toolTipText of the MenuButton.

Parameters:
o - java.lang.Object

setWidth

public void setWidth(java.lang.Object o)
Sets the width of the MenuButton.

Parameters:
o - java.lang.Object

setX

public void setX(java.lang.Object o)
Sets the X coordinate for the location of the MenuButton.

Parameters:
o - java.lang.Object

setY

public void setY(java.lang.Object o)
Sets the Y coordinate for the location of the MenuButton.

Parameters:
o - java.lang.Object

showMenu

protected void showMenu()
Shows the MenuButton's pop-up menu in a visible area.


showMenu

protected void showMenu(javax.swing.JPopupMenu popup)
Shows the MenuButton's pop-up menu in a visible area.


toString

public java.lang.String toString()
Returns a string representation of the MenuButton.

Returns:
java.lang.String

walkMenu

protected void walkMenu()
Selects the first item of the MenuButton.


IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005