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:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class PopupMenuButton
extends javax.swing.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
See Also:
Serialized Form

Inner classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
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 Summary
PopupMenuButton()
          Constructs a popup menu button with no text, no icon, no tool tip, and no popup menu.
PopupMenuButton(javax.swing.Icon icon, java.lang.String toolTip, javax.swing.Icon arrowIcon, java.lang.String arrowToolTip, javax.swing.JPopupMenu popup)
          Constructs a popup menu button with an icon, tool tip, and popup menu.
PopupMenuButton(javax.swing.Icon icon, java.lang.String toolTip, javax.swing.JPopupMenu popup)
          Constructs a popup menu button with an icon, tool tip, and popup menu.
PopupMenuButton(javax.swing.Icon icon, java.lang.String toolTip, java.lang.String arrowToolTip, javax.swing.JPopupMenu popup)
          Constructs a popup menu button with an icon, tool tip, and popup menu.
PopupMenuButton(java.lang.String text, javax.swing.Icon icon, java.lang.String toolTip, javax.swing.Icon arrowIcon, java.lang.String arrowToolTip, javax.swing.JPopupMenu popup)
          Constructs a popup menu button with set text, icon, tool tip, and popup menu.
PopupMenuButton(java.lang.String text, javax.swing.Icon icon, java.lang.String toolTip, javax.swing.JPopupMenu popup)
          Constructs a popup menu button with set text, icon, tool tip, and popup menu.
PopupMenuButton(java.lang.String text, javax.swing.Icon icon, java.lang.String toolTip, java.lang.String arrowToolTip, javax.swing.JPopupMenu popup)
          Constructs a popup menu button with set text, icon, tool tip, and popup menu.
 
Method Summary
 void addActionListener(java.awt.event.ActionListener al)
          adds an ActionListener to the main button
 java.lang.String getActionCommand()
          Returns the action command for the main button
 javax.swing.JToggleButton getArrowButton()
          Returns the arrow button
 javax.swing.JButton getButton()
          Returns the main button
 javax.swing.JPopupMenu getPopupMenu()
          Returns the popup menu
 boolean isEnabled()
          Checks if the PopupMenuButton is disabled
 void removeActionListener(java.awt.event.ActionListener al)
          removes an ActionListener from the main button
 void setActionCommand(java.lang.String action)
          Sets the action command for the main button
 void setEnabled(boolean b)
          Enables (or disables) the entire control
 void setPopupMenu(javax.swing.JPopupMenu menu)
          Sets the popup menu to be displayed.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, paramString, updateUI
 
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, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, 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
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(javax.swing.Icon icon,
                       java.lang.String toolTip,
                       javax.swing.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(javax.swing.Icon icon,
                       java.lang.String toolTip,
                       java.lang.String arrowToolTip,
                       javax.swing.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(javax.swing.Icon icon,
                       java.lang.String toolTip,
                       javax.swing.Icon arrowIcon,
                       java.lang.String arrowToolTip,
                       javax.swing.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(java.lang.String text,
                       javax.swing.Icon icon,
                       java.lang.String toolTip,
                       javax.swing.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(java.lang.String text,
                       javax.swing.Icon icon,
                       java.lang.String toolTip,
                       java.lang.String arrowToolTip,
                       javax.swing.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(java.lang.String text,
                       javax.swing.Icon icon,
                       java.lang.String toolTip,
                       javax.swing.Icon arrowIcon,
                       java.lang.String arrowToolTip,
                       javax.swing.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(java.lang.String action)
Sets the action command for the main button
Since:
v5r1m0

getActionCommand

public java.lang.String getActionCommand()
Returns the action command for the main button
Since:
v5r1m0

addActionListener

public void addActionListener(java.awt.event.ActionListener al)
adds an ActionListener to the main button
Since:
v5r1m0

removeActionListener

public void removeActionListener(java.awt.event.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 javax.swing.JComponent
Since:
v5r1m0

isEnabled

public boolean isEnabled()
Checks if the PopupMenuButton is disabled
Overrides:
isEnabled in class java.awt.Component
Since:
v5r1m0

getButton

public javax.swing.JButton getButton()
Returns the main button
Since:
v5r1m0

getArrowButton

public javax.swing.JToggleButton getArrowButton()
Returns the arrow button
Since:
v5r1m0

getPopupMenu

public javax.swing.JPopupMenu getPopupMenu()
Returns the popup menu
Since:
v5r1m0

setPopupMenu

public void setPopupMenu(javax.swing.JPopupMenu menu)
Sets the popup menu to be displayed.
Since:
v5r1m0