com.ibm.as400.ui.framework.java
Class PopupMenuButton

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.ibm.as400.ui.framework.java.PopupMenuButton

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class PopupMenuButton
extends JPanel

An implementation of a push button/popup menu combination control. The control consists of 3 parts: the main button, the arrow button, and the popup menu. The popup menu typically displays a list of similar actions that can be performed. The main button typically performs the default action listed in the popup menu. The popup menu is displayed when the arrow button is pressed.

Since:

v5r1m0

Version:

1.0, 08/24/99

Author:

J. Plurad

See Also:

Serialized Form

Nested Class Summary

Modifier and Type	Class and Description

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Modifier and Type	Field and Description

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.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor and Description

PopupMenuButton()
Constructs a popup menu button with no text, no icon, no tool tip, and no popup menu.

PopupMenuButton(Icon icon, String toolTip, Icon arrowIcon, String arrowToolTip, JPopupMenu popup)
Constructs a popup menu button with an icon, tool tip, and popup menu.

PopupMenuButton(Icon icon, String toolTip, JPopupMenu popup)
Constructs a popup menu button with an icon, tool tip, and popup menu.

PopupMenuButton(Icon icon, String toolTip, String arrowToolTip, JPopupMenu popup)
Constructs a popup menu button with an icon, tool tip, and popup menu.

PopupMenuButton(String text, Icon icon, String toolTip, Icon arrowIcon, String arrowToolTip, JPopupMenu popup)
Constructs a popup menu button with set text, icon, tool tip, and popup menu.

PopupMenuButton(String text, Icon icon, String toolTip, JPopupMenu popup)
Constructs a popup menu button with set text, icon, tool tip, and popup menu.

PopupMenuButton(String text, Icon icon, String toolTip, String arrowToolTip, JPopupMenu popup)
Constructs a popup menu button with set text, icon, tool tip, and popup menu.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener al) adds an ActionListener to the main button
String	getActionCommand() Returns the action command for the main button
JToggleButton	getArrowButton() Returns the arrow button
JButton	getButton() Returns the main button
JPopupMenu	getPopupMenu() Returns the popup menu
boolean	isEnabled() Checks if the PopupMenuButton is disabled
void	removeActionListener(ActionListener al) removes an ActionListener from the main button
void	setActionCommand(String action) Sets the action command for the main button
void	setEnabled(boolean b) Enables (or disables) the entire control
void	setPopupMenu(JPopupMenu menu) Sets the popup menu to be displayed.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

PopupMenuButton

public PopupMenuButton()

Constructs a popup menu button with no text, no icon, no tool tip, and no popup menu.

Since:

v5r1m0

PopupMenuButton

public PopupMenuButton(Icon icon,
                       String toolTip,
                       JPopupMenu popup)

Constructs a popup menu button with an icon, tool tip, and popup menu. The arrow button will use the same tool tip as the main button.

Parameters:

icon - the icon image to display on the main button

toolTip - the tool tip for the main and arrow buttons

popup - the popup menu to be displayed

Since:

v5r1m0

PopupMenuButton

public PopupMenuButton(Icon icon,
                       String toolTip,
                       String arrowToolTip,
                       JPopupMenu popup)

Constructs a popup menu button with an icon, tool tip, and popup menu.

Parameters:

icon - the icon image to display on the main button

toolTip - the tool tip for the main button

arrowToolTip - the tool tip for the arrow button

popup - the popup menu to be displayed

Since:

v5r1m0

PopupMenuButton

public PopupMenuButton(Icon icon,
                       String toolTip,
                       Icon arrowIcon,
                       String arrowToolTip,
                       JPopupMenu popup)

Constructs a popup menu button with an icon, tool tip, and popup menu.

Parameters:

icon - the icon image to display on the main button

toolTip - the tool tip for the main button

arrowIcon - the icon image to display on the arrow button

arrowToolTip - the tool tip for the arrow button

popup - the popup menu to be displayed

Since:

v5r1m0

PopupMenuButton

public PopupMenuButton(String text,
                       Icon icon,
                       String toolTip,
                       JPopupMenu popup)

Constructs a popup menu button with set text, icon, tool tip, and popup menu. The arrow button will use the same tool tip as the main button.

Parameters:

text - the text of the main button

icon - the icon image to display on the main button

toolTip - the tool tip for the main and arrow buttons

popup - the popup menu to be displayed

Since:

v5r1m0

PopupMenuButton

public PopupMenuButton(String text,
                       Icon icon,
                       String toolTip,
                       String arrowToolTip,
                       JPopupMenu popup)

Constructs a popup menu button with set text, icon, tool tip, and popup menu.

Parameters:

text - the text of the main button

icon - the icon image to display on the main button

toolTip - the tool tip for the main button

arrowToolTip - the tool tip for the arrow button

popup - the popup menu to be displayed

Since:

v5r1m0

PopupMenuButton

public PopupMenuButton(String text,
                       Icon icon,
                       String toolTip,
                       Icon arrowIcon,
                       String arrowToolTip,
                       JPopupMenu popup)

Constructs a popup menu button with set text, icon, tool tip, and popup menu.

Parameters:

text - the text of the main button

icon - the icon image to display on the main button

toolTip - the tool tip for the main button

arrowIcon - the icon image to display on the arrow button

arrowToolTip - the tool tip for the arrow button

popup - the popup menu to be displayed

Since:

v5r1m0

Method Detail

setActionCommand

public void setActionCommand(String action)

Sets the action command for the main button

Since:

v5r1m0

getActionCommand

public String getActionCommand()

Returns the action command for the main button

Since:

v5r1m0

addActionListener

public void addActionListener(ActionListener al)

adds an ActionListener to the main button

Since:

v5r1m0

removeActionListener

public void removeActionListener(ActionListener al)

removes an ActionListener from the main button

Since:

v5r1m0

setEnabled

public void setEnabled(boolean b)

Enables (or disables) the entire control

Overrides:

setEnabled in class JComponent

Since:

v5r1m0

isEnabled

public boolean isEnabled()

Checks if the PopupMenuButton is disabled

Overrides:

isEnabled in class Component

Since:

v5r1m0

getButton

public JButton getButton()

Returns the main button

Since:

v5r1m0

getArrowButton

public JToggleButton getArrowButton()

Returns the arrow button

Since:

v5r1m0

getPopupMenu

public JPopupMenu getPopupMenu()

Returns the popup menu

Since:

v5r1m0

setPopupMenu

public void setPopupMenu(JPopupMenu menu)

Sets the popup menu to be displayed.

Since:

v5r1m0