|
|||||||||
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
public abstract class AbstractCommandButton
Base class for command buttons.
Nested Class Summary | |
---|---|
static class |
AbstractCommandButton.CommandButtonLocationOrderKind
Enumerates the available values for the location order kind. |
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 org.pushingpixels.flamingo.api.common.AbstractCommandButton.ActionHandler |
actionHandler
Action handler for the button. |
protected String |
actionKeyTip
Key tip for the action area. |
protected ActionButtonModel |
actionModel
The button action model. |
protected int |
customDimension
The dimension of the icon of the associated command button in the CommandButtonDisplayState.FIT_TO_ICON state. |
protected ResizableIcon |
disabledIcon
Associated disabled icon. |
protected CommandButtonDisplayState |
displayState
Current display state of this button. |
protected String |
extraText
Additional text. |
protected ResizableIcon |
icon
Associated icon. |
protected boolean |
isFlat
Indication whether this button is flat. |
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 | |
---|---|
AbstractCommandButton(String text,
ResizableIcon icon)
Creates a new command button. |
Method Summary | |
---|---|
void |
addActionListener(ActionListener l)
Adds the specified action listener to this button. |
void |
addChangeListener(ChangeListener l)
Adds the specified change listener to this button. |
void |
doActionClick()
Programmatically perform an action "click". |
protected void |
fireActionPerformed(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. |
String |
getActionKeyTip()
Returns the key tip for the action area of this button. |
ActionButtonModel |
getActionModel()
Returns the action model for this button. |
int |
getCustomDimension()
Returns the dimension of the icon of the associated command button in the CommandButtonDisplayState.FIT_TO_ICON state. |
ResizableIcon |
getDisabledIcon()
Returns the associated disabled icon. |
CommandButtonDisplayState |
getDisplayState()
Return the current display state of this button. |
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. |
ResizableIcon |
getIcon()
Returns the associated icon. |
AbstractCommandButton.CommandButtonLocationOrderKind |
getLocationOrderKind()
Returns the location order kind for buttons placed in command button strips or for buttons that need the visuals of segmented strips. |
RichTooltip |
getRichTooltip(MouseEvent mouseEvent)
|
String |
getText()
Returns the text of this button. |
CommandButtonUI |
getUI()
Returns the UI delegate for this button. |
double |
getVGapScaleFactor()
Returns the vertical gap scale factor for the content of this button. |
boolean |
isFlat()
Returns indication whether this button has flat appearance. |
void |
removeActionListener(ActionListener l)
Removes the specified action listener from this button. |
void |
removeChangeListener(ChangeListener l)
Removes the specified change listener from this button. |
void |
setActionKeyTip(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 |
setDisabledIcon(ResizableIcon disabledIcon)
Sets the disabled icon for this button. |
void |
setDisplayState(CommandButtonDisplayState state)
Sets new display state for this button. |
void |
setEnabled(boolean b)
|
void |
setExtraText(String extraText)
Sets the extra text for this button. |
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(ResizableIcon defaultIcon)
Sets new icon for this button. |
void |
setLocationOrderKind(AbstractCommandButton.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 |
setText(String text)
Sets the new text for this button. |
void |
setToolTipText(String text)
|
void |
setUI(CommandButtonUI ui)
Sets the new UI delegate. |
void |
setVGapScaleFactor(double vgapScaleFactor)
Sets new vertical gap scale factor for the content of this button. |
void |
updateCustomDimension(int dimension)
Updates the dimension of the icon of the associated command button in the CommandButtonDisplayState.FIT_TO_ICON state. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected ResizableIcon icon
setIcon(ResizableIcon)
,
getIcon()
protected ResizableIcon disabledIcon
setDisabledIcon(ResizableIcon)
,
getDisabledIcon()
protected ActionButtonModel actionModel
getActionModel()
,
setActionModel(ActionButtonModel)
protected String extraText
CommandButtonDisplayState.TILE
.
setExtraText(String)
,
getExtraText()
protected CommandButtonDisplayState displayState
this
button.
setDisplayState(CommandButtonDisplayState)
,
getDisplayState()
protected int customDimension
CommandButtonDisplayState.FIT_TO_ICON
state.
getCustomDimension()
,
updateCustomDimension(int)
protected boolean isFlat
setFlat(boolean)
,
isFlat()
protected org.pushingpixels.flamingo.api.common.AbstractCommandButton.ActionHandler actionHandler
protected String actionKeyTip
setActionKeyTip(String)
,
getActionKeyTip()
Constructor Detail |
---|
public AbstractCommandButton(String text, ResizableIcon icon)
text
- Button title. May contain any number of words.icon
- Button icon.Method Detail |
---|
public void setUI(CommandButtonUI ui)
ui
- New UI delegate.public CommandButtonUI getUI()
public void setDisplayState(CommandButtonDisplayState state)
this
button. Fires a
displayState
property change event.
state
- New display state.getDisplayState()
public ResizableIcon getIcon()
getDisabledIcon()
,
setIcon(ResizableIcon)
public void setIcon(ResizableIcon defaultIcon)
icon
property change
event.
defaultIcon
- New default icon for this button.setDisabledIcon(ResizableIcon)
,
getIcon()
public void setDisabledIcon(ResizableIcon disabledIcon)
disabledIcon
- Disabled icon for this button.setIcon(ResizableIcon)
,
getDisabledIcon()
public ResizableIcon getDisabledIcon()
setDisabledIcon(ResizableIcon)
,
getIcon()
public CommandButtonDisplayState getDisplayState()
this
button.
this
button.setDisplayState(CommandButtonDisplayState)
public String getExtraText()
setExtraText(String)
public void setExtraText(String extraText)
extraText
property change event.
extraText
- Extra text for this button.getExtraText()
public String getText()
setText(String)
public void setText(String text)
text
property
change event.
text
- The new text for this button.getText()
public void updateCustomDimension(int dimension)
CommandButtonDisplayState.FIT_TO_ICON
state. Fires a
customDimension
property change event.
dimension
- New dimension of the icon of the associated command button in
the CommandButtonDisplayState.FIT_TO_ICON
state.getCustomDimension()
public int getCustomDimension()
CommandButtonDisplayState.FIT_TO_ICON
state.
CommandButtonDisplayState.FIT_TO_ICON
state.updateCustomDimension(int)
public boolean isFlat()
true
if this button has flat appearance,
false
otherwise.setFlat(boolean)
public void setFlat(boolean isFlat)
flat
property change event.
isFlat
- If true
, this button will have flat appearance,
otherwise this button will not have flat appearance.isFlat()
public ActionButtonModel getActionModel()
setActionModel(ActionButtonModel)
public void setActionModel(ActionButtonModel newModel)
actionModel
property change event.
newModel
- The new action model for this button.getActionModel()
public void addActionListener(ActionListener l)
l
- Action listener to add.removeActionListener(ActionListener)
public void removeActionListener(ActionListener l)
l
- Action listener to remove.addActionListener(ActionListener)
public void addChangeListener(ChangeListener l)
l
- Change listener to add.removeChangeListener(ChangeListener)
public void removeChangeListener(ChangeListener l)
l
- Change listener to remove.addChangeListener(ChangeListener)
public void setEnabled(boolean b)
setEnabled
in class JComponent
protected void fireStateChanged()
EventListenerList
protected void fireActionPerformed(ActionEvent event)
event
parameter.
event
- the ActionEvent
objectEventListenerList
public void setHorizontalAlignment(int alignment)
horizontalAlignment
property change event.
alignment
- New horizontal alignment for the content of this button.getHorizontalAlignment()
public int getHorizontalAlignment()
setHorizontalAlignment(int)
public void setHGapScaleFactor(double hgapScaleFactor)
hgapScaleFactor
property change event.
hgapScaleFactor
- New horizontal gap scale factor for the content of this
button.getHGapScaleFactor()
,
setVGapScaleFactor(double)
,
setGapScaleFactor(double)
public void setVGapScaleFactor(double vgapScaleFactor)
vgapScaleFactor
property change event.
vgapScaleFactor
- New vertical gap scale factor for the content of this button.getVGapScaleFactor()
,
setHGapScaleFactor(double)
,
setGapScaleFactor(double)
public void setGapScaleFactor(double gapScaleFactor)
gapScaleFactor
- New gap scale factor for the content of this button.getHGapScaleFactor()
,
getVGapScaleFactor()
public double getHGapScaleFactor()
setHGapScaleFactor(double)
,
setGapScaleFactor(double)
,
getVGapScaleFactor()
public double getVGapScaleFactor()
setVGapScaleFactor(double)
,
setGapScaleFactor(double)
,
getHGapScaleFactor()
public void doActionClick()
public void setActionRichTooltip(RichTooltip richTooltip)
richTooltip
- Rich tooltip for the action area of this button.getRichTooltip(MouseEvent)
public RichTooltip getRichTooltip(MouseEvent mouseEvent)
getRichTooltip
in class RichToolTipManager.JTrackableComponent
public void setToolTipText(String text)
setToolTipText
in class JComponent
public AbstractCommandButton.CommandButtonLocationOrderKind getLocationOrderKind()
setLocationOrderKind(CommandButtonLocationOrderKind)
public void setLocationOrderKind(AbstractCommandButton.CommandButtonLocationOrderKind locationOrderKind)
locationOrderKind
property change event.
locationOrderKind
- The location order kind for buttons placed in command button
strips or for buttons that need the visuals of segmented
strips.getLocationOrderKind()
public String getActionKeyTip()
setActionKeyTip(String)
public void setActionKeyTip(String actionKeyTip)
actionKeyTip
property change event.
actionKeyTip
- The key tip for the action area of this button.getActionKeyTip()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |