Package org.pushingpixels.flamingo.api.common

Class JCommandMenuButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.pushingpixels.flamingo.api.common.RichToolTipManager.JTrackableComponent

org.pushingpixels.flamingo.api.common.AbstractCommandButton

org.pushingpixels.flamingo.api.common.JCommandButton

org.pushingpixels.flamingo.api.common.JCommandMenuButton

public class JCommandMenuButton
extends JCommandButton

A command button that can be placed in JCommandPopupMenus and in the primary / secondary panels of the ribbon application menu.

See Also:

JCommandPopupMenu.addMenuButton(JCommandMenuButton), Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.pushingpixels.flamingo.api.common.AbstractCommandButton

AbstractCommandButton.CommandButtonLocationOrderKind

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

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

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class org.pushingpixels.flamingo.api.common.JCommandButton

JCommandButton.CommandButtonKind, JCommandButton.CommandButtonPopupOrientationKind

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

javax.swing.JComponent.AccessibleJComponent

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	uiClassID	The UI class ID string.

Fields inherited from class org.pushingpixels.flamingo.api.common.AbstractCommandButton

actionHandler, actionKeyTip, actionModel, customDimension, DEFAULT_GAP_SCALE_FACTOR, DEFAULT_HORIZONTAL_ALIGNMENT, disabledIcon, displayState, extraText, icon, isFlat

Fields inherited from class java.awt.Component

accessibleContext, 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

Fields inherited from class org.pushingpixels.flamingo.api.common.JCommandButton

autoRepeatInitialInterval, autoRepeatSubsequentInterval, commandButtonKind, DEFAULT_AUTO_REPEAT_INITIAL_INTERVAL_MS, DEFAULT_AUTO_REPEAT_SUBSEQUENT_INTERVAL_MS, isAutoRepeatAction, isFireActionOnRollover, popupCallback, popupHandler, popupKeyTip, popupModel, popupOrientationKind

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Constructor Summary

Constructors

Constructor	Description
JCommandMenuButton(java.lang.String title, org.pushingpixels.neon.icon.ResizableIcon icon)	Creates a new command menu button.

Method Summary

Modifier and Type	Method	Description
void	addRolloverActionListener(RolloverActionListener l)	Adds a rollover action listener that will be called when the rollover state of this button becomes active.
void	doActionRollover()	Programmatically perform a "rollover" on the action area.
java.lang.String	getUIClassID()
void	removeRolloverActionListener(RolloverActionListener l)	Removes the specified rollover action listener.
void	updateUI()

Methods inherited from class org.pushingpixels.flamingo.api.common.AbstractCommandButton

addActionListener, addChangeListener, doActionClick, fireActionPerformed, fireStateChanged, getActionKeyTip, getActionModel, getCustomDimension, getDisabledIcon, getDisplayState, getExtraText, getHGapScaleFactor, getHorizontalAlignment, getIcon, getLocationOrderKind, getText, getUI, getVGapScaleFactor, isFlat, removeActionListener, removeChangeListener, setActionModel, setActionRichTooltip, setDisabledIcon, setDisplayState, setExtraText, setFlat, setGapScaleFactor, setHGapScaleFactor, setHorizontalAlignment, setIcon, setLocationOrderKind, setText, setToolTipText, setUI, setVGapScaleFactor, updateCustomDimension

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, getAccessibleContext, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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 org.pushingpixels.flamingo.api.common.JCommandButton

doPopupClick, firePopupActionPerformed, getAutoRepeatInitialInterval, getAutoRepeatSubsequentInterval, getCommandButtonKind, getPopupCallback, getPopupKeyTip, getPopupModel, getPopupOrientationKind, getRichTooltip, isAutoRepeatAction, isFireActionOnRollover, setActionKeyTip, setAutoRepeatAction, setAutoRepeatActionIntervals, setCommandButtonKind, setEnabled, setFireActionOnRollover, setPopupCallback, setPopupKeyTip, setPopupModel, setPopupOrientationKind, setPopupRichTooltip

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.lang.Object

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

Field Detail

uiClassID

public static final java.lang.String uiClassID

The UI class ID string.

See Also:

Constant Field Values

Constructor Detail

JCommandMenuButton

public JCommandMenuButton(java.lang.String title,
                          org.pushingpixels.neon.icon.ResizableIcon icon)

Creates a new command menu button.

Parameters:

title - Command menu button title.

icon - Command menu button icon.

Method Detail

addRolloverActionListener

public void addRolloverActionListener(RolloverActionListener l)

Adds a rollover action listener that will be called when the rollover state of this button becomes active.

Parameters:

l - The rollover action listener to add.

See Also:

removeRolloverActionListener(RolloverActionListener)

removeRolloverActionListener

public void removeRolloverActionListener(RolloverActionListener l)

Removes the specified rollover action listener.

Parameters:

l - The listener to remove.

See Also:

addRolloverActionListener(RolloverActionListener)

getUIClassID

public java.lang.String getUIClassID()

Overrides:

getUIClassID in class JCommandButton

updateUI

public void updateUI()

Overrides:

updateUI in class JCommandButton

doActionRollover

public void doActionRollover()

Programmatically perform a "rollover" on the action area. This does the same thing as if the user had moved the mouse over the action area of the button.