|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.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
public class JCommandButton
Command button.
Nested Class Summary | |
---|---|
static class |
JCommandButton.CommandButtonKind
Enumerates the available command button kinds. |
static class |
JCommandButton.CommandButtonPopupOrientationKind
Orientation kind for the popup. |
Nested classes/interfaces inherited from class org.pushingpixels.flamingo.api.common.AbstractCommandButton |
---|
AbstractCommandButton.CommandButtonLocationOrderKind |
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 | |
---|---|
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. |
Fields inherited from class org.pushingpixels.flamingo.api.common.AbstractCommandButton |
---|
actionHandler, actionKeyTip, actionModel, customDimension, disabledIcon, displayState, extraText, icon, isFlat |
Fields inherited from class javax.swing.JComponent |
---|
accessibleContext, 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 |
---|
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 | |
---|---|
JCommandButton(ResizableIcon icon)
Creates a new command button with empty text |
|
JCommandButton(String title)
Creates a new command button without an icon. |
|
JCommandButton(String title,
ResizableIcon icon)
Creates a new command button. |
Method Summary | |
---|---|
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()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String uiClassID
protected PopupPanelCallback popupCallback
null
.
setPopupCallback(PopupPanelCallback)
,
getPopupCallback()
protected JCommandButton.CommandButtonKind commandButtonKind
setCommandButtonKind(CommandButtonKind)
,
getCommandButtonKind()
protected JCommandButton.CommandButtonPopupOrientationKind popupOrientationKind
setPopupOrientationKind(CommandButtonPopupOrientationKind)
,
getPopupOrientationKind()
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.
autoRepeatInitialInterval
,
autoRepeatSubsequentInterval
,
setAutoRepeatAction(boolean)
,
isAutoRepeatAction()
protected int autoRepeatInitialInterval
isAutoRepeatAction
,
autoRepeatSubsequentInterval
,
getAutoRepeatInitialInterval()
,
setAutoRepeatActionIntervals(int, int)
protected int autoRepeatSubsequentInterval
isAutoRepeatAction
,
autoRepeatInitialInterval
,
getAutoRepeatSubsequentInterval()
,
setAutoRepeatActionIntervals(int, int)
protected boolean isFireActionOnRollover
isAutoRepeatAction
can model quick pan
buttons such as breadcrumb bar scrollers.
setFireActionOnRollover(boolean)
,
isFireActionOnRollover()
protected PopupButtonModel popupModel
setPopupModel(PopupButtonModel)
,
getPopupModel()
protected org.pushingpixels.flamingo.api.common.JCommandButton.PopupHandler popupHandler
protected String popupKeyTip
setPopupKeyTip(String)
,
getPopupKeyTip()
Constructor Detail |
---|
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.Method Detail |
---|
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()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |