oracle.jdevimpl.audit.swing

Class MenuDropDownButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JToggleButton

oracle.jdevimpl.audit.swing.MenuDropDownButton

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.MenuElement, javax.swing.SwingConstants

public class MenuDropDownButton
extends javax.swing.JToggleButton
implements javax.swing.MenuElement

A toggle button which combines a label, icon, or nested button with a drop down arrow and drops down a popup window when pressed. When created with a label and/or icon, the entire button actuates the popup window. When created with a nested button (typically a JButton or JToggleButton), the drop down button becomes a split button where the left half is the nested button with its normal behavior and the right half actuates the popup window. The popup window typically hosts a menu--the programming interface is oriented to that--but it can host one or more Components of arbitrary complexity.

The popup component(s) can be added through the constructor or after construction through the various add methods, for example in a popupMenuWillBecomeVisible method of a PopupMenuListener added to this button.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MenuDropDownButton.AccessibleMenuButton Taken more or less verbatim from JMenu.AccessibleJMenu and its superclass JMenu.AccessibleJMenuItem.
class	MenuDropDownButton.ButtonListener

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

javax.swing.JToggleButton.AccessibleJToggleButton, javax.swing.JToggleButton.ToggleButtonModel

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

javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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

Constructors

Constructor and Description
MenuDropDownButton(javax.swing.AbstractButton button, java.awt.Component... components)
MenuDropDownButton(javax.swing.AbstractButton button, java.lang.String tip, java.awt.Component... components)
MenuDropDownButton(javax.swing.Icon icon, java.awt.Component... components)
MenuDropDownButton(javax.swing.Icon icon, java.lang.String tip, java.awt.Component... components)
MenuDropDownButton(java.lang.String text, javax.swing.Icon icon, java.awt.Component... components)
MenuDropDownButton(java.lang.String text, javax.swing.Icon icon, java.lang.String tip, java.awt.Component... components)

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JMenuItem	add(javax.swing.Action action) Adds a new JMenuItem derived from an Action at the end of the popup menu.
void	add(java.awt.Component... components) Adds components at the end of the popup menu.
java.awt.Component	add(java.awt.Component c) Adds a component at the end of the popup menu.
java.awt.Component	add(java.awt.Component component, int index) Adds a component at a position in the popup menu.
javax.swing.JMenuItem	add(javax.swing.JMenuItem menuItem) Adds a JMenuItem at the end of the popup menu.
javax.swing.JMenuItem	add(java.lang.String text) Adds a new JMenuItem at the end of the popup menu.
void	addPopupMenuListener(javax.swing.event.PopupMenuListener listener)
javax.accessibility.AccessibleContext	getAccessibleContext()
java.awt.Component	getComponent()
java.awt.Dimension	getMaximumSize() Overridden to add space for the drop down arrow to the width.
java.awt.Component	getMenuComponent(int index)
int	getMenuComponentCount()
java.awt.Component[]	getMenuComponents()
javax.swing.JMenuItem	getMenuItem(int index)
java.awt.Dimension	getMinimumSize() Overridden to add space for the drop down arrow to the width.
javax.swing.JPopupMenu	getPopupMenu() Gets the popup menu.
java.awt.Dimension	getPreferredSize() Overridden to add space for the drop down arrow to the width and to limit the height to to the height of the contained button, if any.
javax.swing.MenuElement[]	getSubElements()
protected void	hidePopup() Hide the popup if it is showing.
protected boolean	isPopupVisible()
void	layout()
void	menuSelectionChanged(boolean isIncluded)
void	paint(java.awt.Graphics g) Overridden to paint the drop arrow in the space reserved for it.
void	processKeyEvent(java.awt.event.KeyEvent event, javax.swing.MenuElement[] path, javax.swing.MenuSelectionManager manager)
void	processMouseEvent(java.awt.event.MouseEvent e) Ensures that a MOUSE_PRESSED is not propagated while the popup is cancelling (see Tracker#propertyChange) and otherwise ensures that a MOUSE_PRESSED requests focus.
void	processMouseEvent(java.awt.event.MouseEvent event, javax.swing.MenuElement[] path, javax.swing.MenuSelectionManager manager)
void	remove(java.awt.Component component) Removes a component from the popup menu.
void	remove(int position) Removes the component at a position from the popup menu.
void	remove(javax.swing.JMenuItem item) Removes a JMenuItem from the popup menu.
void	removeAll() Removes all component from the popup menu.
void	removePopupMenuListener(javax.swing.event.PopupMenuListener listener)
void	setBorder(javax.swing.border.Border border)
void	setMargin(java.awt.Insets margin)
void	setRolloverEnabled(boolean enabled)
protected void	showPopup() Shows the popup menu if it is not showing.

Methods inherited from class javax.swing.JToggleButton

getUIClassID, paramString, updateUI

Methods inherited from class javax.swing.AbstractButton

actionPropertyChanged, addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, 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, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, 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, addContainerListener, 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, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, 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

MenuDropDownButton

public MenuDropDownButton(java.lang.String text,
                  javax.swing.Icon icon,
                  java.awt.Component... components)

MenuDropDownButton

public MenuDropDownButton(javax.swing.Icon icon,
                  java.awt.Component... components)

MenuDropDownButton

public MenuDropDownButton(javax.swing.Icon icon,
                  java.lang.String tip,
                  java.awt.Component... components)

MenuDropDownButton

public MenuDropDownButton(java.lang.String text,
                  javax.swing.Icon icon,
                  java.lang.String tip,
                  java.awt.Component... components)

MenuDropDownButton

public MenuDropDownButton(javax.swing.AbstractButton button,
                  java.awt.Component... components)

MenuDropDownButton

public MenuDropDownButton(javax.swing.AbstractButton button,
                  java.lang.String tip,
                  java.awt.Component... components)

Method Detail

addPopupMenuListener

public void addPopupMenuListener(javax.swing.event.PopupMenuListener listener)

removePopupMenuListener

public void removePopupMenuListener(javax.swing.event.PopupMenuListener listener)

setMargin

public void setMargin(java.awt.Insets margin)

Overrides:

setMargin in class javax.swing.AbstractButton

setBorder

public void setBorder(javax.swing.border.Border border)

Overrides:

setBorder in class javax.swing.JComponent

setRolloverEnabled

public void setRolloverEnabled(boolean enabled)

Overrides:

setRolloverEnabled in class javax.swing.AbstractButton

getMinimumSize

public java.awt.Dimension getMinimumSize()

Overridden to add space for the drop down arrow to the width.

Overrides:

getMinimumSize in class javax.swing.JComponent

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overridden to add space for the drop down arrow to the width and to limit the height to to the height of the contained button, if any.

Overrides:

getPreferredSize in class javax.swing.JComponent

getMaximumSize

public java.awt.Dimension getMaximumSize()

Overridden to add space for the drop down arrow to the width.

Overrides:

getMaximumSize in class javax.swing.JComponent

layout

public void layout()

Overrides:

layout in class java.awt.Container

paint

public void paint(java.awt.Graphics g)

Overridden to paint the drop arrow in the space reserved for it.

Overrides:

paint in class javax.swing.JComponent

getPopupMenu

public javax.swing.JPopupMenu getPopupMenu()

Gets the popup menu.

add

public javax.swing.JMenuItem add(javax.swing.JMenuItem menuItem)

Adds a JMenuItem at the end of the popup menu.

Returns:

the added JMenuItem.

add

public java.awt.Component add(java.awt.Component c)

Adds a component at the end of the popup menu.

Overrides:

add in class java.awt.Container

Returns:

the added component.

add

public java.awt.Component add(java.awt.Component component,
                     int index)

Adds a component at a position in the popup menu. A position of -1 adds to the end.

Overrides:

add in class java.awt.Container

Returns:

the added component.

add

public void add(java.awt.Component... components)

Adds components at the end of the popup menu.

add

public javax.swing.JMenuItem add(java.lang.String text)

Adds a new JMenuItem at the end of the popup menu.

Parameters:

text - the text of the menu item to be added

Returns:

the created and added JMenuItem.

add

public javax.swing.JMenuItem add(javax.swing.Action action)

Adds a new JMenuItem derived from an Action at the end of the popup menu.

Parameters:

action - the action from which to derive text, icon, selected, etc.

Returns:

the created and added JMenuItem.

remove

public void remove(javax.swing.JMenuItem item)

Removes a JMenuItem from the popup menu.

remove

public void remove(int position)

Removes the component at a position from the popup menu.

Overrides:

remove in class java.awt.Container

remove

public void remove(java.awt.Component component)

Removes a component from the popup menu.

Overrides:

remove in class java.awt.Container

removeAll

public void removeAll()

Removes all component from the popup menu.

Overrides:

removeAll in class java.awt.Container

getMenuComponentCount

public int getMenuComponentCount()

getMenuComponent

public java.awt.Component getMenuComponent(int index)

getMenuItem

public javax.swing.JMenuItem getMenuItem(int index)

getMenuComponents

public java.awt.Component[] getMenuComponents()

showPopup

protected void showPopup()

Shows the popup menu if it is not showing.

hidePopup

protected void hidePopup()

Hide the popup if it is showing.

isPopupVisible

protected boolean isPopupVisible()

getComponent

public java.awt.Component getComponent()

Specified by:

getComponent in interface javax.swing.MenuElement

processMouseEvent

public void processMouseEvent(java.awt.event.MouseEvent event,
                     javax.swing.MenuElement[] path,
                     javax.swing.MenuSelectionManager manager)

Specified by:

processMouseEvent in interface javax.swing.MenuElement

processKeyEvent

public void processKeyEvent(java.awt.event.KeyEvent event,
                   javax.swing.MenuElement[] path,
                   javax.swing.MenuSelectionManager manager)

Specified by:

processKeyEvent in interface javax.swing.MenuElement

menuSelectionChanged

public void menuSelectionChanged(boolean isIncluded)

Specified by:

menuSelectionChanged in interface javax.swing.MenuElement

getSubElements

public javax.swing.MenuElement[] getSubElements()

Specified by:

getSubElements in interface javax.swing.MenuElement

processMouseEvent

public void processMouseEvent(java.awt.event.MouseEvent e)

Ensures that a MOUSE_PRESSED is not propagated while the popup is cancelling (see Tracker#propertyChange) and otherwise ensures that a MOUSE_PRESSED requests focus. Note that using a MouseListener rather than overriding processMouseEvent does not seem to work because it runs later, after Tracker#popupCancelling has gone back to false.

Overrides:

processMouseEvent in class javax.swing.JComponent

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()

Specified by:

getAccessibleContext in interface javax.accessibility.Accessible

Overrides:

getAccessibleContext in class javax.swing.JToggleButton