public class RibbonApplicationMenuEntryFooter
extends java.lang.Object
RibbonApplicationMenu
. The footer entries at runtime are represented
by JCommandButton.CommandButtonKind.ACTION_ONLY
command buttons placed in a
right-aligned row along the bottom edge of the ribbon application menu.Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
actionKeyTip
Optional key tip for the action area of the command button that
represents this menu entry.
|
protected RichTooltip |
actionRichTooltip
Optional tooltip for the action area of the command button that
represents this menu entry.
|
protected ResizableIcon |
disabledIcon
The menu icon for disabled state.
|
protected JCommandButton.CommandButtonKind |
entryKind
The kind of the command button that represents this menu entry.
|
protected ResizableIcon |
icon
The menu icon.
|
protected boolean |
isEnabled
Enabled state of this menu.
|
protected java.awt.event.ActionListener |
mainActionListener
The main action listener for this menu entry.
|
protected java.lang.String |
popupKeyTip
Optional key tip for the popup area of the command button that represents
this menu entry.
|
protected RichTooltip |
popupRichTooltip
Optional tooltip for the popup area of the command button that represents
this menu entry.
|
protected java.lang.String |
text
The menu text.
|
Constructor and Description |
---|
RibbonApplicationMenuEntryFooter(ResizableIcon icon,
java.lang.String text,
java.awt.event.ActionListener mainActionListener)
Creates the metadata description of a
RibbonApplicationMenu
footer menu entry. |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getActionKeyTip()
Returns the key tip for the action area of the command button that
represents this menu entry.
|
RichTooltip |
getActionRichTooltip()
Returns the rich tooltip for the action area of the command
button that represents this menu entry.
|
ResizableIcon |
getDisabledIcon()
Returns the disabled icon for the command button that represents this
menu entry.
|
JCommandButton.CommandButtonKind |
getEntryKind()
Returns the kind of the command button that represents this menu entry.
|
ResizableIcon |
getIcon()
Returns the icon of this application menu entry.
|
java.awt.event.ActionListener |
getMainActionListener()
Returns the main action listener associated with this application menu
entry.
|
java.lang.String |
getPopupKeyTip()
Returns the key tip for the popup area of the command button that
represents this menu entry.
|
RichTooltip |
getPopupRichTooltip()
Returns the rich tooltip for the popup area of the command
button that represents this menu entry.
|
java.lang.String |
getText()
Returns the text of this application menu entry.
|
boolean |
isEnabled()
Returns the enabled state of the command button that represents this menu
entry.
|
void |
setActionKeyTip(java.lang.String actionKeyTip)
Sets the new value for the key tip for the action area of the command
button that represents this menu entry.
|
void |
setActionRichTooltip(RichTooltip actionRichTooltip)
Sets the rich tooltip for the action area of the command
button that represents this menu entry.
|
void |
setDisabledIcon(ResizableIcon disabledIcon)
Sets the disabled icon for the command button that represents this menu
entry.
|
void |
setEnabled(boolean isEnabled)
Sets the enabled state of the command button that represents this menu
entry.
|
void |
setPopupKeyTip(java.lang.String popupKeyTip)
Sets the new value for the key tip for the popup area of the command
button that represents this menu entry.
|
void |
setPopupRichTooltip(RichTooltip popupRichTooltip)
Sets the rich tooltip for the popup area of the command
button that represents this menu entry.
|
void |
setText(java.lang.String text)
Sets the new text for this application menu entry.
|
protected ResizableIcon icon
protected ResizableIcon disabledIcon
null
.protected java.lang.String text
protected java.awt.event.ActionListener mainActionListener
protected JCommandButton.CommandButtonKind entryKind
protected boolean isEnabled
protected java.lang.String actionKeyTip
protected java.lang.String popupKeyTip
protected RichTooltip actionRichTooltip
protected RichTooltip popupRichTooltip
public RibbonApplicationMenuEntryFooter(ResizableIcon icon, java.lang.String text, java.awt.event.ActionListener mainActionListener)
RibbonApplicationMenu
footer menu entry.icon
- The icon of this footer menu entry. Must be non-
null
.text
- The text of this footer menu entry. Must be non-
null
.mainActionListener
- The main action listener for this footer menu entry. While
this can be null
, clicking on the matching button
will have no effect.public ResizableIcon getIcon()
public java.lang.String getText()
setText(String)
public void setText(java.lang.String text)
text
- The new text for this application menu entry.getText()
public java.awt.event.ActionListener getMainActionListener()
public JCommandButton.CommandButtonKind getEntryKind()
public void setEnabled(boolean isEnabled)
isEnabled
- If true
, the command button that represents this
menu entry will be enabled, if false
, the command
button will be disabled.isEnabled
public boolean isEnabled()
true
if the command button that represents this menu
entry is enabled, false
otherwise.public java.lang.String getActionKeyTip()
setActionKeyTip(String)
,
getPopupKeyTip()
public void setActionKeyTip(java.lang.String actionKeyTip)
actionKeyTip
- The new value for the key tip for the action area of the
command button that represents this menu entry.getActionKeyTip()
,
setPopupKeyTip(String)
public java.lang.String getPopupKeyTip()
setPopupKeyTip(String)
,
getActionKeyTip()
public void setPopupKeyTip(java.lang.String popupKeyTip)
popupKeyTip
- The new value for the key tip for the popup area of the
command button that represents this menu entry.getPopupKeyTip()
,
setActionKeyTip(String)
public RichTooltip getActionRichTooltip()
#setPopupTooltip(RichTooltip)
,
getActionRichTooltip()
public void setActionRichTooltip(RichTooltip actionRichTooltip)
actionRichTooltip
- The rich tooltip for the action area of the command
button that represents this menu entry.getActionRichTooltip()
,
#setActionTooltip(RichTooltip)
public RichTooltip getPopupRichTooltip()
#setPopupTooltip(RichTooltip)
,
getActionRichTooltip()
public void setPopupRichTooltip(RichTooltip popupRichTooltip)
popupRichTooltip
- The rich tooltip for the popup area of the command
button that represents this menu entry.getPopupRichTooltip()
,
#setActionTooltip(RichTooltip)
public ResizableIcon getDisabledIcon()
setDisabledIcon(ResizableIcon)
public void setDisabledIcon(ResizableIcon disabledIcon)
disabledIcon
- The disabled icon for the command button that represents this
menu entry.getDisabledIcon()