Class JCommandButton
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
org.pushingpixels.radiance.component.api.common.JCommandButton
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,RichTooltipManager.WithRichTooltip
- Direct Known Subclasses:
JRibbonTaskToggleButton
Command button. Note that while this class is a part of public API, it is highly
recommended to use the
Command
and CommandButtonPresentationModel
instances used to project the command button on screen for any dynamic manipulation
of the state.- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) class
Default action handler for this button.private static class
Extension of the default button model that supports thePopupButtonModel
interface.(package private) class
Default popup handler.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
FieldsModifier and TypeFieldDescriptionprivate JCommandButton.ActionHandler
Action handler for the button.private ActionButtonModel
The button action model.private BaseCommand
private JCommandButton.PopupHandler
Default popup handler for this button.private PopupButtonModel
Popup model of this button.private CommandButtonPresentationState
Current presentation state ofthis
button.private BaseCommandButtonProjection
<? extends BaseCommand<?>, ? extends BaseCommandMenuContentModel, ? extends BaseCommandButtonPresentationModel<?, ?>, ? extends BaseCommandPopupMenuPresentationModel> static final String
The UI class ID string.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
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
-
Constructor Summary
ConstructorsConstructorDescriptionJCommandButton
(BaseCommandButtonProjection<? extends BaseCommand<?>, ? extends BaseCommandMenuContentModel, ? extends BaseCommandButtonPresentationModel<?, ?>, ? extends BaseCommandPopupMenuPresentationModel> projection) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the specified change listener to this button.void
Adds the specified command listener to this button.void
Adds a rollover action listener that will be called when the rollover state of this button becomes active.void
Programmatically perform an action "click".void
Programmatically perform a "rollover" on the action area.void
Programmatically perform a "click" on the popup area.protected void
fireActionPerformed
(ActionEvent event) Notifies all listeners that have registered interest for notification on this event type.protected void
Notifies all listeners that have registered interest for notification on this event type.protected void
Notifies all listeners that have registered interest for notification on this event type.Returns the action model for this button.BaseCommand
<? extends BaseCommandMenuContentModel> Returns the popup model of this button.BaseCommandButtonPresentationModel
<? extends BaseCommandPopupMenuPresentationModel, ? extends BaseCommandButtonPresentationModel<?, ?>> Return the current presentation state ofthis
button.BaseCommandButtonProjection
<? extends BaseCommand<?>, ? extends BaseCommandMenuContentModel, ? extends BaseCommandButtonPresentationModel<?, ?>, ? extends BaseCommandPopupMenuPresentationModel> getRichTooltip
(MouseEvent event) getUI()
Returns the UI delegate for this button.boolean
void
Removes the specified change listener from this button.void
Removes the specified command listener from this button.void
Removes the specified rollover action listener.void
setActionModel
(ActionButtonModel newModel) Sets the new action model for this button.void
setEnabled
(boolean b) void
setPopupModel
(PopupButtonModel newModel) Sets the new popup model for this button.void
Sets new presentation state forthis
button.void
setToolTipText
(String text) void
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, 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.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, 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:
-
projection
private BaseCommandButtonProjection<? extends BaseCommand<?>,? extends BaseCommandMenuContentModel, projection? extends BaseCommandButtonPresentationModel<?, ?>, ? extends BaseCommandPopupMenuPresentationModel> -
command
-
commandPresentation
-
actionModel
The button action model.- See Also:
-
presentationState
Current presentation state ofthis
button.- See Also:
-
actionHandler
Action handler for the button. -
popupModel
Popup model of this button.- See Also:
-
popupHandler
Default popup handler for this button.
-
-
Constructor Details
-
JCommandButton
public JCommandButton(BaseCommandButtonProjection<? extends BaseCommand<?>, ? extends BaseCommandMenuContentModel, ? extends BaseCommandButtonPresentationModel<?, ?>, ? extends BaseCommandPopupMenuPresentationModel> projection)
-
-
Method Details
-
getUI
Returns the UI delegate for this button.- Overrides:
getUI
in classJComponent
- Returns:
- The UI delegate for this button.
-
getProjection
public BaseCommandButtonProjection<? extends BaseCommand<?>,? extends BaseCommandMenuContentModel, getProjection()? extends BaseCommandButtonPresentationModel<?, ?>, ? extends BaseCommandPopupMenuPresentationModel> -
getContentModel
-
getPresentationModel
public BaseCommandButtonPresentationModel<? extends BaseCommandPopupMenuPresentationModel,? extends BaseCommandButtonPresentationModel<?, getPresentationModel()?>> -
setPresentationState
Sets new presentation state forthis
button. Fires apresentationState
property change event.- Parameters:
state
- New presentation state.- See Also:
-
getPresentationState
Return the current presentation state ofthis
button.- Returns:
- The current presentation state of
this
button. - See Also:
-
getActionModel
Returns the action model for this button.- Returns:
- The action model for this button.
- See Also:
-
setActionModel
Sets the new action model for this button. Fires anactionModel
property change event.- Parameters:
newModel
- The new action model for this button.- See Also:
-
addCommandListener
Adds the specified command listener to this button.- Parameters:
l
- Command listener to add.- See Also:
-
removeCommandListener
Removes the specified command listener from this button.- Parameters:
l
- Command listener to remove.- See Also:
-
addChangeListener
Adds the specified change listener to this button.- Parameters:
l
- Change listener to add.- See Also:
-
removeChangeListener
Removes the specified change listener from this button.- Parameters:
l
- Change listener to remove.- See Also:
-
fireStateChanged
protected void fireStateChanged()Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created.- See Also:
-
fireActionPerformed
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using theevent
parameter.- Parameters:
event
- theActionEvent
object- See Also:
-
doActionClick
public void doActionClick()Programmatically perform an action "click". This does the same thing as if the user had pressed and released the action area of the button. -
setToolTipText
- Overrides:
setToolTipText
in classJComponent
-
updateUI
public void updateUI()- Overrides:
updateUI
in classJComponent
-
getUIClassID
- Overrides:
getUIClassID
in classJComponent
-
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 apopupModel
property change event.- Parameters:
newModel
- The new popup model for this button.- See Also:
-
setEnabled
public void setEnabled(boolean b) - Overrides:
setEnabled
in classJComponent
-
firePopupActionPerformed
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using theevent
parameter.- Parameters:
event
- theActionEvent
object- See Also:
-
getRichTooltip
- Specified by:
getRichTooltip
in interfaceRichTooltipManager.WithRichTooltip
-
getRichTooltipPresentationModel
- Specified by:
getRichTooltipPresentationModel
in interfaceRichTooltipManager.WithRichTooltip
-
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. -
isPopupVisible
public boolean isPopupVisible() -
addRolloverActionListener
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
Removes the specified rollover action listener.- Parameters:
l
- The listener to remove.- See Also:
-
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.
-