ImageObserver
, MenuContainer
, Serializable
BasicRibbonGalleryUI.ExpandCommandButton
, JCommandMenuButton
, JRibbonApplicationMenuButton
public class JCommandButton extends AbstractCommandButton
Modifier and Type | Class | Description |
---|---|---|
static class |
JCommandButton.CommandButtonKind |
Enumerates the available command button kinds.
|
static class |
JCommandButton.CommandButtonPopupOrientationKind |
Orientation kind for the popup.
|
AbstractCommandButton.CommandButtonLocationOrderKind
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Container.AccessibleAWTContainer
JComponent.AccessibleJComponent
Modifier and Type | Field | Description |
---|---|---|
protected int |
autoRepeatInitialInterval |
The initial interval for invoking the registered action listeners in the
auto-repeat action mode.
|
protected int |
autoRepeatSubsequentInterval |
The subsequent interval for invoking the registered action listeners in
the auto-repeat action mode.
|
protected JCommandButton.CommandButtonKind |
commandButtonKind |
The command button kind of this button.
|
protected boolean |
isAutoRepeatAction |
Indicates the auto-repeat action mode.
|
protected boolean |
isFireActionOnRollover |
Indicates that rollover should result in firing the action.
|
protected PopupPanelCallback |
popupCallback |
Associated popup callback.
|
protected org.pushingpixels.flamingo.api.common.JCommandButton.PopupHandler |
popupHandler |
Default popup handler for this button.
|
protected String |
popupKeyTip |
Key tip for the popup area of this button.
|
protected PopupButtonModel |
popupModel |
Popup model of this button.
|
protected JCommandButton.CommandButtonPopupOrientationKind |
popupOrientationKind |
The popup orientation kind of this button.
|
static String |
uiClassID |
The UI class ID string.
|
actionHandler, actionKeyTip, actionModel, customDimension, disabledIcon, displayState, extraText, icon, isFlat
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor | Description |
---|---|
JCommandButton(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
|
Modifier and Type | Method | Description |
---|---|---|
void |
doPopupClick() |
Programmatically perform a "click" on the popup area.
|
protected void |
firePopupActionPerformed(ActionEvent event) |
Notifies all listeners that have registered interest for notification on
this event type.
|
int |
getAutoRepeatInitialInterval() |
Returns the initial interval for invoking the registered action listeners
in the auto-repeat action mode.
|
int |
getAutoRepeatSubsequentInterval() |
Returns the subsequent interval for invoking the registered action
listeners in the auto-repeat action mode.
|
JCommandButton.CommandButtonKind |
getCommandButtonKind() |
Returns the command button kind of this button.
|
PopupPanelCallback |
getPopupCallback() |
Returns the associated popup callback.
|
String |
getPopupKeyTip() |
Returns the key tip for the popup area of this button.
|
PopupButtonModel |
getPopupModel() |
Returns the popup model of this button.
|
JCommandButton.CommandButtonPopupOrientationKind |
getPopupOrientationKind() |
Returns the popup orientation kind of this button.
|
RichTooltip |
getRichTooltip(MouseEvent event) |
|
String |
getUIClassID() |
|
boolean |
isAutoRepeatAction() |
Returns indication whether the button is in auto-repeat action mode.
|
boolean |
isFireActionOnRollover() |
Returns indication whether this button is in action-on-rollover mode.
|
void |
setActionKeyTip(String actionKeyTip) |
Sets the key tip for the action area of this button.
|
void |
setAutoRepeatAction(boolean isAutoRepeatAction) |
Sets the auto-repeat action indication.
|
void |
setAutoRepeatActionIntervals(int initial,
int subsequent) |
Sets the intervals for the auto-repeat action mode.
|
void |
setCommandButtonKind(JCommandButton.CommandButtonKind commandButtonKind) |
Sets the kind for this button.
|
void |
setEnabled(boolean b) |
|
void |
setFireActionOnRollover(boolean isFireActionOnRollover) |
Sets action-on-rollover mode.
|
void |
setPopupCallback(PopupPanelCallback popupCallback) |
Sets new popup callback for
this button. |
void |
setPopupKeyTip(String popupKeyTip) |
Sets the key tip for the popup area of this button.
|
void |
setPopupModel(PopupButtonModel newModel) |
Sets the new popup model for this button.
|
void |
setPopupOrientationKind(JCommandButton.CommandButtonPopupOrientationKind popupOrientationKind) |
Sets the popup orientation for this button.
|
void |
setPopupRichTooltip(RichTooltip richTooltip) |
Sets the rich tooltip for the popup area of this button.
|
void |
updateUI() |
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
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
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
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
public static final String uiClassID
protected PopupPanelCallback popupCallback
null
.protected JCommandButton.CommandButtonKind commandButtonKind
protected JCommandButton.CommandButtonPopupOrientationKind popupOrientationKind
protected boolean isAutoRepeatAction
AbstractButton
). 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 after getAutoRepeatInitialInterval()
, the
action listeners will be activated every
getAutoRepeatSubsequentInterval()
until the button is disabled
or the mouse is released.protected int autoRepeatInitialInterval
protected int autoRepeatSubsequentInterval
protected boolean isFireActionOnRollover
isAutoRepeatAction
can model quick pan
buttons such as breadcrumb bar scrollers.protected PopupButtonModel popupModel
setPopupModel(PopupButtonModel)
,
getPopupModel()
protected org.pushingpixels.flamingo.api.common.JCommandButton.PopupHandler popupHandler
protected String popupKeyTip
setPopupKeyTip(String)
,
getPopupKeyTip()
public JCommandButton(ResizableIcon icon)
icon
- Button icon.public JCommandButton(String title)
title
- Button title. May contain any number of words.public JCommandButton(String title, ResizableIcon icon)
title
- Button title. May contain any number of words.icon
- Button icon.public JCommandButton.CommandButtonKind getCommandButtonKind()
setCommandButtonKind(CommandButtonKind)
public void setCommandButtonKind(JCommandButton.CommandButtonKind commandButtonKind)
commandButtonKind
property change event.commandButtonKind
- The new button kind.getCommandButtonKind()
public JCommandButton.CommandButtonPopupOrientationKind getPopupOrientationKind()
setPopupOrientationKind(CommandButtonPopupOrientationKind)
public void setPopupOrientationKind(JCommandButton.CommandButtonPopupOrientationKind popupOrientationKind)
popupOrientationKind
property change event.popupOrientationKind
- The new popup orientation kind.getPopupOrientationKind()
public void updateUI()
updateUI
in class JComponent
public String getUIClassID()
getUIClassID
in class JComponent
public PopupPanelCallback getPopupCallback()
setPopupCallback(PopupPanelCallback)
public void setPopupCallback(PopupPanelCallback popupCallback)
this
button.popupCallback
- New popup callback for this
button.getPopupCallback()
public void setAutoRepeatAction(boolean isAutoRepeatAction)
isAutoRepeatAction
- If true
, 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 base
AbstractButton
). 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
after getAutoRepeatInitialInterval()
, the action
listeners will be activated every
getAutoRepeatSubsequentInterval()
until the button is
disabled or the mouse is released.setAutoRepeatActionIntervals(int, int)
,
isAutoRepeatAction()
public void setAutoRepeatActionIntervals(int initial, int subsequent)
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.setAutoRepeatAction(boolean)
,
isAutoRepeatAction()
,
getAutoRepeatInitialInterval()
,
getAutoRepeatSubsequentInterval()
public boolean isAutoRepeatAction()
true
if the button is in auto-repeat action mode,
false
otherwise.setAutoRepeatAction(boolean)
,
setAutoRepeatActionIntervals(int, int)
,
getAutoRepeatInitialInterval()
,
getAutoRepeatSubsequentInterval()
public int getAutoRepeatInitialInterval()
setAutoRepeatActionIntervals(int, int)
,
setAutoRepeatAction(boolean)
,
isAutoRepeatAction()
,
getAutoRepeatSubsequentInterval()
public int getAutoRepeatSubsequentInterval()
setAutoRepeatActionIntervals(int, int)
,
setAutoRepeatAction(boolean)
,
isAutoRepeatAction()
,
getAutoRepeatInitialInterval()
public void setFireActionOnRollover(boolean isFireActionOnRollover)
setAutoRepeatAction(boolean)
passing true
to get
auto-repeat action fired on rollover (useful for quicker manipulation of
scroller buttons, for example).isFireActionOnRollover
- If true
, the button is moved into the
action-on-rollover mode.isFireActionOnRollover()
public boolean isFireActionOnRollover()
true
if this button is in action-on-rollover mode,
false
otherwise.setFireActionOnRollover(boolean)
public PopupButtonModel getPopupModel()
setPopupModel(PopupButtonModel)
public void setPopupModel(PopupButtonModel newModel)
popupModel
property change event.newModel
- The new popup model for this button.getPopupModel()
public void setEnabled(boolean b)
setEnabled
in class AbstractCommandButton
protected void firePopupActionPerformed(ActionEvent event)
event
parameter.event
- the ActionEvent
objectEventListenerList
public void setPopupRichTooltip(RichTooltip richTooltip)
richTooltip
- Rich tooltip for the popup area of this button.getRichTooltip(MouseEvent)
,
AbstractCommandButton.setActionRichTooltip(RichTooltip)
public RichTooltip getRichTooltip(MouseEvent event)
getRichTooltip
in class AbstractCommandButton
public String getPopupKeyTip()
setPopupKeyTip(String)
,
AbstractCommandButton.getActionKeyTip()
public void setPopupKeyTip(String popupKeyTip)
popupKeyTip
property change event.popupKeyTip
- The key tip for the popup area of this button.getPopupKeyTip()
,
setActionKeyTip(String)
public void setActionKeyTip(String actionKeyTip)
AbstractCommandButton
actionKeyTip
property change event.setActionKeyTip
in class AbstractCommandButton
actionKeyTip
- The key tip for the action area of this button.AbstractCommandButton.getActionKeyTip()
public void doPopupClick()