Package org.pushingpixels.flamingo.api.common

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

public class JCommandButton
extends RichTooltipManager.JTrackableComponent

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JCommandButton.CommandButtonKind	Enumerates the available command button kinds.
static class	JCommandButton.CommandButtonLocationOrderKind	Enumerates the available values for the location order kind.

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 javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Field Summary

Fields

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

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 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
JCommandButton(Projection<JCommandButton,? extends Command,CommandButtonPresentationModel> projection)

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(javax.swing.event.ChangeListener l)	Adds the specified change listener to this button.
void	addCommandListener(CommandAction l)	Adds the specified command listener to this button.
void	addRolloverActionListener(RolloverActionListener l)	Adds a rollover action listener that will be called when the rollover state of this button becomes active.
void	doActionClick()	Programmatically perform an action "click".
void	doActionRollover()	Programmatically perform a "rollover" on the action area.
void	doPopupClick()	Programmatically perform a "click" on the popup area.
protected void	fireActionPerformed(java.awt.event.ActionEvent event)	Notifies all listeners that have registered interest for notification on this event type.
protected void	firePopupActionPerformed(java.awt.event.ActionEvent event)	Notifies all listeners that have registered interest for notification on this event type.
protected void	fireStateChanged()	Notifies all listeners that have registered interest for notification on this event type.
java.lang.String	getActionKeyTip()	Returns the key tip for the action area of this button.
ActionButtonModel	getActionModel()	Returns the action model for this button.
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.
org.pushingpixels.neon.api.icon.ResizableIcon	getDisabledIcon()	Returns the associated disabled icon.
java.lang.String	getExtraText()	Returns the extra text of this button.
double	getHGapScaleFactor()	Returns the horizontal gap scale factor for the content of this button.
int	getHorizontalAlignment()	Returns the horizontal alignment for the content of this button.
org.pushingpixels.neon.api.icon.ResizableIcon	getIcon()	Returns the associated icon.
int	getIconDimension()	Returns the dimension of the icon of the associated command button in the CommandButtonPresentationState.FIT_TO_ICON state.
JCommandButton.CommandButtonLocationOrderKind	getLocationOrderKind()	Returns the location order kind for buttons placed in command button strips or for buttons that need the visuals of segmented strips.
PopupPanelCallback	getPopupCallback()	Returns the associated popup callback.
CommandButtonPresentationModel.PopupHorizontalGravity	getPopupHorizontalGravity()	Returns the popup horizontal gravity of this button.
java.lang.String	getPopupKeyTip()	Returns the key tip for the popup area of this button.
PopupButtonModel	getPopupModel()	Returns the popup model of this button.
CommandButtonPresentationModel.PopupOrientationKind	getPopupOrientationKind()	Returns the popup orientation kind of this button.
CommandButtonPresentationState	getPresentationState()	Return the current presentation state of this button.
CommandButtonProjection<? extends Command>	getProjection()
RichTooltip	getRichTooltip(java.awt.event.MouseEvent event)
java.lang.String	getText()	Returns the text of this button.
org.pushingpixels.flamingo.internal.ui.common.CommandButtonUI	getUI()	Returns the UI delegate for this button.
java.lang.String	getUIClassID()
double	getVGapScaleFactor()	Returns the vertical gap scale factor for the content of this button.
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.
boolean	isFlat()	Returns indication whether this button has flat appearance.
boolean	isPopupVisible()
void	removeChangeListener(javax.swing.event.ChangeListener l)	Removes the specified change listener from this button.
void	removeCommandListener(CommandAction l)	Removes the specified command listener from this button.
void	removeRolloverActionListener(RolloverActionListener l)	Removes the specified rollover action listener.
void	setActionKeyTip(java.lang.String actionKeyTip)	Sets the key tip for the action area of this button.
void	setActionModel(ActionButtonModel newModel)	Sets the new action model for this button.
void	setActionRichTooltip(RichTooltip richTooltip)	Sets the rich tooltip 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	setDisabledIcon(org.pushingpixels.neon.api.icon.ResizableIcon disabledIcon)	Sets the disabled icon for this button.
void	setEnabled(boolean b)
void	setExtraText(java.lang.String extraText)	Sets the extra text for this button.
void	setFireActionOnRollover(boolean isFireActionOnRollover)	Sets action-on-rollover mode.
void	setFlat(boolean isFlat)	Sets the flat appearance of this button.
void	setGapScaleFactor(double gapScaleFactor)	Sets new gap scale factor for the content of this button.
void	setHGapScaleFactor(double hgapScaleFactor)	Sets new horizontal gap scale factor for the content of this button.
void	setHorizontalAlignment(int alignment)	Sets new horizontal alignment for the content of this button.
void	setIcon(org.pushingpixels.neon.api.icon.ResizableIcon defaultIcon)	Sets new icon for this button.
void	setIconDimension(int dimension)	Updates the dimension of the icon of the associated command button in the CommandButtonPresentationState.FIT_TO_ICON state.
void	setLocationOrderKind(JCommandButton.CommandButtonLocationOrderKind locationOrderKind)	Sets the location order kind for buttons placed in command button strips or for buttons that need the visuals of segmented strips.
void	setPopupCallback(PopupPanelCallback popupCallback)	Sets new popup callback for this button.
void	setPopupHorizontalGravity(CommandButtonPresentationModel.PopupHorizontalGravity popupHorizontalGravity)	Sets the popup horizontal gravity for this button.
void	setPopupKeyTip(java.lang.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(CommandButtonPresentationModel.PopupOrientationKind popupOrientationKind)	Sets the popup orientation for this button.
void	setPopupRichTooltip(RichTooltip richTooltip)	Sets the rich tooltip for the popup area of this button.
void	setPresentationState(CommandButtonPresentationState state)	Sets new presentation state for this button.
void	setText(java.lang.String text)	Sets the new text for this button.
void	setToolTipText(java.lang.String text)
void	setVGapScaleFactor(double vgapScaleFactor)	Sets new vertical gap scale factor for the content of this button.
void	updateUI()

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

DEFAULT_HORIZONTAL_ALIGNMENT

public static final int DEFAULT_HORIZONTAL_ALIGNMENT

See Also:

Constant Field Values

DEFAULT_GAP_SCALE_FACTOR

public static final double DEFAULT_GAP_SCALE_FACTOR

See Also:

Constant Field Values

uiClassID

public static final java.lang.String uiClassID

The UI class ID string.

See Also:

Constant Field Values

Constructor Detail

JCommandButton

public JCommandButton(Projection<JCommandButton,? extends Command,CommandButtonPresentationModel> projection)

Method Detail

getUI

public org.pushingpixels.flamingo.internal.ui.common.CommandButtonUI getUI()

Returns the UI delegate for this button.

Overrides:

getUI in class javax.swing.JComponent

Returns:

The UI delegate for this button.

getProjection

public CommandButtonProjection<? extends Command> getProjection()

setPresentationState

public void setPresentationState(CommandButtonPresentationState state)

Sets new presentation state for this button. Fires a presentationState property change event.

Parameters:

state - New presentation state.

See Also:

getPresentationState()

getIcon

public org.pushingpixels.neon.api.icon.ResizableIcon getIcon()

Returns the associated icon.

Returns:

The associated icon.

See Also:

getDisabledIcon(), setIcon(ResizableIcon)

setIcon

public void setIcon(org.pushingpixels.neon.api.icon.ResizableIcon defaultIcon)

Sets new icon for this button. Fires an icon property change event.

Parameters:

defaultIcon - New default icon for this button.

See Also:

setDisabledIcon(ResizableIcon), getIcon()

setDisabledIcon

public void setDisabledIcon(org.pushingpixels.neon.api.icon.ResizableIcon disabledIcon)

Sets the disabled icon for this button.

Parameters:

disabledIcon - Disabled icon for this button.

See Also:

setIcon(ResizableIcon), getDisabledIcon()

getDisabledIcon

public org.pushingpixels.neon.api.icon.ResizableIcon getDisabledIcon()

Returns the associated disabled icon.

Returns:

The associated disabled icon.

See Also:

setDisabledIcon(ResizableIcon), getIcon()

getPresentationState

public CommandButtonPresentationState getPresentationState()

Return the current presentation state of this button.

Returns:

The current presentation state of this button.

See Also:

setPresentationState(CommandButtonPresentationState)

getExtraText

public java.lang.String getExtraText()

Returns the extra text of this button.

Returns:

Extra text of this button.

See Also:

setExtraText(String)

setExtraText

public void setExtraText(java.lang.String extraText)

Sets the extra text for this button. Fires an extraText property change event.

Parameters:

extraText - Extra text for this button.

See Also:

getExtraText()

getText

public java.lang.String getText()

Returns the text of this button.

Returns:

The text of this button.

See Also:

setText(String)

setText

public void setText(java.lang.String text)

Sets the new text for this button. Fires a text property change event.

Parameters:

text - The new text for this button.

See Also:

getText()

setIconDimension

public void setIconDimension(int dimension)

Updates the dimension of the icon of the associated command button in the CommandButtonPresentationState.FIT_TO_ICON state. Fires an iconDimension property change event.

Parameters:

dimension - New dimension of the icon of the associated command button in the CommandButtonPresentationState.FIT_TO_ICON state.

See Also:

getIconDimension()

getIconDimension

public int getIconDimension()

Returns the dimension of the icon of the associated command button in the CommandButtonPresentationState.FIT_TO_ICON state.

Returns:

The dimension of the icon of the associated command button in the CommandButtonPresentationState.FIT_TO_ICON state.

See Also:

setIconDimension(int)

isFlat

public boolean isFlat()

Returns indication whether this button has flat appearance.

Returns:

true if this button has flat appearance, false otherwise.

See Also:

setFlat(boolean)

setFlat

public void setFlat(boolean isFlat)

Sets the flat appearance of this button. Fires a flat property change event.

Parameters:

isFlat - If true, this button will have flat appearance, otherwise this button will not have flat appearance.

See Also:

isFlat()

getActionModel

public ActionButtonModel getActionModel()

Returns the action model for this button.

Returns:

The action model for this button.

See Also:

setActionModel(ActionButtonModel)

setActionModel

public void setActionModel(ActionButtonModel newModel)

Sets the new action model for this button. Fires an actionModel property change event.

Parameters:

newModel - The new action model for this button.

See Also:

getActionModel()

addCommandListener

public void addCommandListener(CommandAction l)

Adds the specified command listener to this button.

Parameters:

l - Command listener to add.

See Also:

removeCommandListener(CommandAction)

removeCommandListener

public void removeCommandListener(CommandAction l)

Removes the specified command listener from this button.

Parameters:

l - Command listener to remove.

See Also:

addCommandListener(CommandAction)

addChangeListener

public void addChangeListener(javax.swing.event.ChangeListener l)

Adds the specified change listener to this button.

Parameters:

l - Change listener to add.

See Also:

removeChangeListener(ChangeListener)

removeChangeListener

public void removeChangeListener(javax.swing.event.ChangeListener l)

Removes the specified change listener from this button.

Parameters:

l - Change listener to remove.

See Also:

addChangeListener(ChangeListener)

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:

EventListenerList

fireActionPerformed

protected void fireActionPerformed(java.awt.event.ActionEvent event)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the event parameter.

Parameters:

event - the ActionEvent object

See Also:

EventListenerList

setHorizontalAlignment

public void setHorizontalAlignment(int alignment)

Sets new horizontal alignment for the content of this button. Fires a horizontalAlignment property change event.

Parameters:

alignment - New horizontal alignment for the content of this button.

See Also:

getHorizontalAlignment()

getHorizontalAlignment

public int getHorizontalAlignment()

Returns the horizontal alignment for the content of this button.

Returns:

The horizontal alignment for the content of this button.

See Also:

setHorizontalAlignment(int)

setHGapScaleFactor

public void setHGapScaleFactor(double hgapScaleFactor)

Sets new horizontal gap scale factor for the content of this button. Fires an hgapScaleFactor property change event.

Parameters:

hgapScaleFactor - New horizontal gap scale factor for the content of this button.

See Also:

getHGapScaleFactor(), setVGapScaleFactor(double), setGapScaleFactor(double)

setVGapScaleFactor

public void setVGapScaleFactor(double vgapScaleFactor)

Sets new vertical gap scale factor for the content of this button. Fires a vgapScaleFactor property change event.

Parameters:

vgapScaleFactor - New vertical gap scale factor for the content of this button.

See Also:

getVGapScaleFactor(), setHGapScaleFactor(double), setGapScaleFactor(double)

setGapScaleFactor

public void setGapScaleFactor(double gapScaleFactor)

Sets new gap scale factor for the content of this button.

Parameters:

gapScaleFactor - New gap scale factor for the content of this button.

See Also:

getHGapScaleFactor(), getVGapScaleFactor()

getHGapScaleFactor

public double getHGapScaleFactor()

Returns the horizontal gap scale factor for the content of this button.

Returns:

The horizontal gap scale factor for the content of this button.

See Also:

setHGapScaleFactor(double), setGapScaleFactor(double), getVGapScaleFactor()

getVGapScaleFactor

public double getVGapScaleFactor()

Returns the vertical gap scale factor for the content of this button.

Returns:

The vertical gap scale factor for the content of this button.

See Also:

setVGapScaleFactor(double), setGapScaleFactor(double), getHGapScaleFactor()

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.

setActionRichTooltip

public void setActionRichTooltip(RichTooltip richTooltip)

Sets the rich tooltip for the action area of this button.

Parameters:

richTooltip - Rich tooltip for the action area of this button.

See Also:

getRichTooltip(MouseEvent)

setToolTipText

public void setToolTipText(java.lang.String text)

Overrides:

setToolTipText in class javax.swing.JComponent

getLocationOrderKind

public JCommandButton.CommandButtonLocationOrderKind getLocationOrderKind()

Returns the location order kind for buttons placed in command button strips or for buttons that need the visuals of segmented strips.

Returns:

The location order kind for buttons placed in command button strips or for buttons that need the visuals of segmented strips.

See Also:

setLocationOrderKind(CommandButtonLocationOrderKind)

setLocationOrderKind

public void setLocationOrderKind(JCommandButton.CommandButtonLocationOrderKind locationOrderKind)

Sets the location order kind for buttons placed in command button strips or for buttons that need the visuals of segmented strips. Fires a locationOrderKind property change event.

Parameters:

locationOrderKind - The location order kind for buttons placed in command button strips or for buttons that need the visuals of segmented strips.

See Also:

getLocationOrderKind()

getActionKeyTip

public java.lang.String getActionKeyTip()

Returns the key tip for the action area of this button.

Returns:

The key tip for the action area of this button.

See Also:

setActionKeyTip(String)

setActionKeyTip

public void setActionKeyTip(java.lang.String actionKeyTip)

Sets the key tip for the action area of this button. Fires an actionKeyTip property change event.

Parameters:

actionKeyTip - The key tip for the action area of this button.

See Also:

getActionKeyTip()

getCommandButtonKind

public JCommandButton.CommandButtonKind getCommandButtonKind()

Returns the command button kind of this button.

Returns:

Command button kind of this button.

See Also:

setCommandButtonKind(CommandButtonKind)

setCommandButtonKind

public void setCommandButtonKind(JCommandButton.CommandButtonKind commandButtonKind)

Sets the kind for this button. Fires a commandButtonKind property change event.

Parameters:

commandButtonKind - The new button kind.

See Also:

getCommandButtonKind()

getPopupOrientationKind

public CommandButtonPresentationModel.PopupOrientationKind getPopupOrientationKind()

Returns the popup orientation kind of this button.

Returns:

Popup orientation kind of this button.

See Also:

setPopupOrientationKind(CommandButtonPresentationModel.PopupOrientationKind)

setPopupOrientationKind

public void setPopupOrientationKind(CommandButtonPresentationModel.PopupOrientationKind popupOrientationKind)

Sets the popup orientation for this button. Fires a popupOrientationKind property change event.

Parameters:

popupOrientationKind - The new popup orientation kind.

See Also:

getPopupOrientationKind()

getPopupHorizontalGravity

public CommandButtonPresentationModel.PopupHorizontalGravity getPopupHorizontalGravity()

Returns the popup horizontal gravity of this button.

Returns:

Popup horizontal gravity of this button.

See Also:

setPopupHorizontalGravity(CommandButtonPresentationModel.PopupHorizontalGravity)

setPopupHorizontalGravity

public void setPopupHorizontalGravity(CommandButtonPresentationModel.PopupHorizontalGravity popupHorizontalGravity)

Sets the popup horizontal gravity for this button. Fires a popupHorizontalGravity property change event.

Parameters:

popupHorizontalGravity - The new popup horizontal gravity.

See Also:

getPopupHorizontalGravity()

updateUI

public void updateUI()

Overrides:

updateUI in class javax.swing.JComponent

getUIClassID

public java.lang.String getUIClassID()

Overrides:

getUIClassID in class javax.swing.JComponent

getPopupCallback

public PopupPanelCallback getPopupCallback()

Returns the associated popup callback.

Returns:

The associated popup callback.

See Also:

setPopupCallback(PopupPanelCallback)

setPopupCallback

public void setPopupCallback(PopupPanelCallback popupCallback)

Sets new popup callback for this button.

Parameters:

popupCallback - New popup callback for this button.

See Also:

getPopupCallback()

setAutoRepeatAction

public void setAutoRepeatAction(boolean isAutoRepeatAction)

Sets the auto-repeat action indication.

Parameters:

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.

See Also:

setAutoRepeatActionIntervals(int, int), isAutoRepeatAction()

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:

setAutoRepeatAction(boolean), isAutoRepeatAction(), getAutoRepeatInitialInterval(), getAutoRepeatSubsequentInterval()

isAutoRepeatAction

public boolean isAutoRepeatAction()

Returns indication whether the button is in auto-repeat action mode.

Returns:

true if the button is in auto-repeat action mode, false otherwise.

See Also:

setAutoRepeatAction(boolean), setAutoRepeatActionIntervals(int, int), getAutoRepeatInitialInterval(), getAutoRepeatSubsequentInterval()

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:

setAutoRepeatActionIntervals(int, int), setAutoRepeatAction(boolean), isAutoRepeatAction(), getAutoRepeatSubsequentInterval()

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:

setAutoRepeatActionIntervals(int, int), setAutoRepeatAction(boolean), isAutoRepeatAction(), getAutoRepeatInitialInterval()

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 with setAutoRepeatAction(boolean) passing true to get auto-repeat action fired on rollover (useful for quicker manipulation of scroller buttons, for example).

Parameters:

isFireActionOnRollover - If true, the button is moved into the action-on-rollover mode.

See Also:

isFireActionOnRollover()

isFireActionOnRollover

public boolean isFireActionOnRollover()

Returns indication whether this button is in action-on-rollover mode.

Returns:

true if this button is in action-on-rollover mode, false otherwise.

See Also:

setFireActionOnRollover(boolean)

getPopupModel

public PopupButtonModel getPopupModel()

Returns the popup model of this button.

Returns:

The popup model of this button.

See Also:

setPopupModel(PopupButtonModel)

setPopupModel

public void setPopupModel(PopupButtonModel newModel)

Sets the new popup model for this button. Fires a popupModel property change event.

Parameters:

newModel - The new popup model for this button.

See Also:

getPopupModel()

setEnabled

public void setEnabled(boolean b)

Overrides:

setEnabled in class javax.swing.JComponent

firePopupActionPerformed

protected void firePopupActionPerformed(java.awt.event.ActionEvent event)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the event parameter.

Parameters:

event - the ActionEvent object

See Also:

EventListenerList

setPopupRichTooltip

public void setPopupRichTooltip(RichTooltip richTooltip)

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(MouseEvent), setActionRichTooltip(RichTooltip)

getRichTooltip

public RichTooltip getRichTooltip(java.awt.event.MouseEvent event)

Specified by:

getRichTooltip in class RichTooltipManager.JTrackableComponent

getPopupKeyTip

public java.lang.String 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(String), getActionKeyTip()

setPopupKeyTip

public void setPopupKeyTip(java.lang.String popupKeyTip)

Sets the key tip for the popup area of this button. Fires a popupKeyTip property change event.

Parameters:

popupKeyTip - The key tip for the popup area of this button.

See Also:

getPopupKeyTip(), setActionKeyTip(String)

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

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)

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.