Class JCommandButton
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
- All Implemented Interfaces:
ImageObserver,MenuContainer,Serializable
- Direct Known Subclasses:
BasicRibbonGalleryUI.ExpandCommandButton,JCommandMenuButton,JRibbonApplicationMenuButton
Command button.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumEnumerates the available command button kinds.static enumOrientation kind for the popup.Nested classes/interfaces inherited from class org.pushingpixels.flamingo.api.common.AbstractCommandButton
AbstractCommandButton.CommandButtonLocationOrderKindNested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected intThe initial interval for invoking the registered action listeners in the auto-repeat action mode.protected intThe subsequent interval for invoking the registered action listeners in the auto-repeat action mode.protected JCommandButton.CommandButtonKindThe command button kind of this button.protected booleanIndicates the auto-repeat action mode.protected booleanIndicates that rollover should result in firing the action.protected PopupPanelCallbackAssociated popup callback.protected org.pushingpixels.flamingo.api.common.JCommandButton.PopupHandlerDefault popup handler for this button.protected StringKey tip for the popup area of this button.protected PopupButtonModelPopup model of this button.The popup orientation kind of this button.static final StringThe UI class ID string.Fields inherited from class org.pushingpixels.flamingo.api.common.AbstractCommandButton
actionHandler, actionKeyTip, actionModel, customDimension, disabledIcon, displayState, extraText, icon, isFlatFields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
ConstructorsConstructorDescriptionJCommandButton(String title) Creates a new command button without an icon.JCommandButton(String title, ResizableIcon icon) Creates a new command button.JCommandButton(ResizableIcon icon) Creates a new command button with empty text -
Method Summary
Modifier and TypeMethodDescriptionvoidProgrammatically perform a "click" on the popup area.protected voidNotifies all listeners that have registered interest for notification on this event type.intReturns the initial interval for invoking the registered action listeners in the auto-repeat action mode.intReturns the subsequent interval for invoking the registered action listeners in the auto-repeat action mode.Returns the command button kind of this button.Returns the associated popup callback.Returns the key tip for the popup area of this button.Returns the popup model of this button.Returns the popup orientation kind of this button.getRichTooltip(MouseEvent event) booleanReturns indication whether the button is in auto-repeat action mode.booleanReturns indication whether this button is in action-on-rollover mode.voidsetActionKeyTip(String actionKeyTip) Sets the key tip for the action area of this button.voidsetAutoRepeatAction(boolean isAutoRepeatAction) Sets the auto-repeat action indication.voidsetAutoRepeatActionIntervals(int initial, int subsequent) Sets the intervals for the auto-repeat action mode.voidsetCommandButtonKind(JCommandButton.CommandButtonKind commandButtonKind) Sets the kind for this button.voidsetEnabled(boolean b) voidsetFireActionOnRollover(boolean isFireActionOnRollover) Sets action-on-rollover mode.voidsetPopupCallback(PopupPanelCallback popupCallback) Sets new popup callback forthisbutton.voidsetPopupKeyTip(String popupKeyTip) Sets the key tip for the popup area of this button.voidsetPopupModel(PopupButtonModel newModel) Sets the new popup model for this button.voidsetPopupOrientationKind(JCommandButton.CommandButtonPopupOrientationKind popupOrientationKind) Sets the popup orientation for this button.voidsetPopupRichTooltip(RichTooltip richTooltip) Sets the rich tooltip for the popup area of this button.voidupdateUI()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, updateCustomDimensionMethods 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, updateMethods 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, validateTreeMethods 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
-
Field Details
-
uiClassID
The UI class ID string.- See Also:
-
popupCallback
Associated popup callback. May benull. -
commandButtonKind
The command button kind of this button. -
popupOrientationKind
The popup orientation kind of this button. -
isAutoRepeatAction
protected boolean isAutoRepeatActionIndicates the auto-repeat action mode. When the button is not in the auto-repeat action mode, the registered action listeners are activated when the mouse is released (just as with the baseAbstractButton). When the button is in auto-repeat mode, the registered action listeners are activated when the mouse is pressed. In addition, if the mouse is still pressed aftergetAutoRepeatInitialInterval(), the action listeners will be activated everygetAutoRepeatSubsequentInterval()until the button is disabled or the mouse is released. -
autoRepeatInitialInterval
protected int autoRepeatInitialIntervalThe initial interval for invoking the registered action listeners in the auto-repeat action mode. -
autoRepeatSubsequentInterval
protected int autoRepeatSubsequentIntervalThe subsequent interval for invoking the registered action listeners in the auto-repeat action mode. -
isFireActionOnRollover
protected boolean isFireActionOnRolloverIndicates that rollover should result in firing the action. Used in conjunction with theisAutoRepeatActioncan model quick pan buttons such as breadcrumb bar scrollers. -
popupModel
Popup model of this button. -
popupHandler
protected org.pushingpixels.flamingo.api.common.JCommandButton.PopupHandler popupHandlerDefault popup handler for this button. -
popupKeyTip
Key tip for the popup area of this button.- See Also:
-
-
Constructor Details
-
JCommandButton
Creates a new command button with empty text- Parameters:
icon- Button icon.
-
JCommandButton
Creates a new command button without an icon.- Parameters:
title- Button title. May contain any number of words.
-
JCommandButton
Creates a new command button.- Parameters:
title- Button title. May contain any number of words.icon- Button icon.
-
-
Method Details
-
getCommandButtonKind
Returns the command button kind of this button.- Returns:
- Command button kind of this button.
- See Also:
-
setCommandButtonKind
Sets the kind for this button. Fires acommandButtonKindproperty change event.- Parameters:
commandButtonKind- The new button kind.- See Also:
-
getPopupOrientationKind
Returns the popup orientation kind of this button.- Returns:
- Popup orientation kind of this button.
- See Also:
-
setPopupOrientationKind
public void setPopupOrientationKind(JCommandButton.CommandButtonPopupOrientationKind popupOrientationKind) Sets the popup orientation for this button. Fires apopupOrientationKindproperty change event.- Parameters:
popupOrientationKind- The new popup orientation kind.- See Also:
-
updateUI
public void updateUI()- Overrides:
updateUIin classJComponent
-
getUIClassID
- Overrides:
getUIClassIDin classJComponent
-
getPopupCallback
Returns the associated popup callback.- Returns:
- The associated popup callback.
- See Also:
-
setPopupCallback
Sets new popup callback forthisbutton.- Parameters:
popupCallback- New popup callback forthisbutton.- See Also:
-
setAutoRepeatAction
public void setAutoRepeatAction(boolean isAutoRepeatAction) Sets the auto-repeat action indication.- Parameters:
isAutoRepeatAction- Iftrue, pressing the button will activate auto-repeat action mode. When the button is not in the auto-repeat action mode, the registered action listeners are activated when the mouse is released (just as with the baseAbstractButton). When the button is in auto-repeat mode, the registered action listeners are activated when the mouse is pressed. In addition, is the mouse is still pressed aftergetAutoRepeatInitialInterval(), the action listeners will be activated everygetAutoRepeatSubsequentInterval()until the button is disabled or the mouse is released.- See Also:
-
setAutoRepeatActionIntervals
public void setAutoRepeatActionIntervals(int initial, int subsequent) Sets the intervals for the auto-repeat action mode.- Parameters:
initial- The initial interval for invoking the registered action listeners in the auto-repeat action mode.subsequent- The subsequent interval for invoking the registered action listeners in the auto-repeat action mode.- See Also:
-
isAutoRepeatAction
public boolean isAutoRepeatAction()Returns indication whether the button is in auto-repeat action mode.- Returns:
trueif the button is in auto-repeat action mode,falseotherwise.- See Also:
-
getAutoRepeatInitialInterval
public int getAutoRepeatInitialInterval()Returns the initial interval for invoking the registered action listeners in the auto-repeat action mode.- Returns:
- The initial interval for invoking the registered action listeners in the auto-repeat action mode.
- See Also:
-
getAutoRepeatSubsequentInterval
public int getAutoRepeatSubsequentInterval()Returns the subsequent interval for invoking the registered action listeners in the auto-repeat action mode.- Returns:
- The subsequent interval for invoking the registered action listeners in the auto-repeat action mode.
- See Also:
-
setFireActionOnRollover
public void setFireActionOnRollover(boolean isFireActionOnRollover) Sets action-on-rollover mode. When this mode is on, button will fire action events when it gets rollover (instead of press). Combine withsetAutoRepeatAction(boolean)passingtrueto get auto-repeat action fired on rollover (useful for quicker manipulation of scroller buttons, for example).- Parameters:
isFireActionOnRollover- Iftrue, the button is moved into the action-on-rollover mode.- See Also:
-
isFireActionOnRollover
public boolean isFireActionOnRollover()Returns indication whether this button is in action-on-rollover mode.- Returns:
trueif this button is in action-on-rollover mode,falseotherwise.- See Also:
-
getPopupModel
Returns the popup model of this button.- Returns:
- The popup model of this button.
- See Also:
-
setPopupModel
Sets the new popup model for this button. Fires apopupModelproperty change event.- Parameters:
newModel- The new popup model for this button.- See Also:
-
setEnabled
public void setEnabled(boolean b) - Overrides:
setEnabledin classAbstractCommandButton
-
firePopupActionPerformed
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using theeventparameter.- Parameters:
event- theActionEventobject- See Also:
-
setPopupRichTooltip
Sets the rich tooltip for the popup area of this button.- Parameters:
richTooltip- Rich tooltip for the popup area of this button.- See Also:
-
getRichTooltip
- Overrides:
getRichTooltipin classAbstractCommandButton
-
getPopupKeyTip
Returns the key tip for the popup area of this button.- Returns:
- The key tip for the popup area of this button.
- See Also:
-
setPopupKeyTip
Sets the key tip for the popup area of this button. Fires apopupKeyTipproperty change event.- Parameters:
popupKeyTip- The key tip for the popup area of this button.- See Also:
-
setActionKeyTip
Description copied from class:AbstractCommandButtonSets the key tip for the action area of this button. Fires anactionKeyTipproperty change event.- Overrides:
setActionKeyTipin classAbstractCommandButton- Parameters:
actionKeyTip- The key tip for the action area of this button.- See Also:
-
doPopupClick
public void doPopupClick()Programmatically perform a "click" on the popup area. This does the same thing as if the user had pressed and released the popup area of the button.
-