Class RibbonApplicationMenuEntryFooter
java.lang.Object
org.pushingpixels.flamingo.api.ribbon.RibbonApplicationMenuEntryFooter
Metadata description for the footer entries of the
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.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
Optional key tip for the action area of the command button that represents this menu entry.protected RichTooltip
Optional tooltip for the action area of the command button that represents this menu entry.protected ResizableIcon
The menu icon for disabled state.protected JCommandButton.CommandButtonKind
The kind of the command button that represents this menu entry.protected ResizableIcon
The menu icon.protected boolean
Enabled state of this menu.protected ActionListener
The main action listener for this menu entry.protected String
Optional key tip for the popup area of the command button that represents this menu entry.protected RichTooltip
Optional tooltip for the popup area of the command button that represents this menu entry.protected String
The menu text. -
Constructor Summary
ConstructorsConstructorDescriptionRibbonApplicationMenuEntryFooter
(ResizableIcon icon, String text, ActionListener mainActionListener) Creates the metadata description of aRibbonApplicationMenu
footer menu entry. -
Method Summary
Modifier and TypeMethodDescriptionReturns the key tip for the action area of the command button that represents this menu entry.Returns the rich tooltip for the action area of the command button that represents this menu entry.Returns the disabled icon for the command button that represents this menu entry.Returns the kind of the command button that represents this menu entry.getIcon()
Returns the icon of this application menu entry.Returns the main action listener associated with this application menu entry.Returns the key tip for the popup area of the command button that represents this menu entry.Returns the rich tooltip for the popup area of the command button that represents this menu entry.getText()
Returns the text of this application menu entry.boolean
Returns the enabled state of the command button that represents this menu entry.void
setActionKeyTip
(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
(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
Sets the new text for this application menu entry.
-
Field Details
-
icon
The menu icon. -
disabledIcon
The menu icon for disabled state. Optional, can benull
. -
text
The menu text. -
mainActionListener
The main action listener for this menu entry. -
entryKind
The kind of the command button that represents this menu entry. -
isEnabled
protected boolean isEnabledEnabled state of this menu. -
actionKeyTip
Optional key tip for the action area of the command button that represents this menu entry. -
popupKeyTip
Optional key tip for the popup area of the command button that represents this menu entry. -
actionRichTooltip
Optional tooltip for the action area of the command button that represents this menu entry. -
popupRichTooltip
Optional tooltip for the popup area of the command button that represents this menu entry.
-
-
Constructor Details
-
RibbonApplicationMenuEntryFooter
public RibbonApplicationMenuEntryFooter(ResizableIcon icon, String text, ActionListener mainActionListener) Creates the metadata description of aRibbonApplicationMenu
footer menu entry.- Parameters:
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 benull
, clicking on the matching button will have no effect.
-
-
Method Details
-
getIcon
Returns the icon of this application menu entry.- Returns:
- The icon of this application menu entry.
-
getText
Returns the text of this application menu entry.- Returns:
- The text of this application menu entry.
- See Also:
-
setText
Sets the new text for this application menu entry.- Parameters:
text
- The new text for this application menu entry.- See Also:
-
getMainActionListener
Returns the main action listener associated with this application menu entry.- Returns:
- The main action listener associated with this application menu entry.
-
getEntryKind
Returns the kind of the command button that represents this menu entry.- Returns:
- The kind of the command button that represents this menu entry.
-
setEnabled
public void setEnabled(boolean isEnabled) Sets the enabled state of the command button that represents this menu entry.- Parameters:
isEnabled
- Iftrue
, the command button that represents this menu entry will be enabled, iffalse
, the command button will be disabled.- See Also:
-
isEnabled
public boolean isEnabled()Returns the enabled state of the command button that represents this menu entry.- Returns:
true
if the command button that represents this menu entry is enabled,false
otherwise.
-
getActionKeyTip
Returns the key tip for the action area of the command button that represents this menu entry.- Returns:
- The key tip for the action area of the command button that represents this menu entry.
- See Also:
-
setActionKeyTip
Sets the new value for the key tip for the action area of the command button that represents this menu entry.- Parameters:
actionKeyTip
- The new value for the key tip for the action area of the command button that represents this menu entry.- See Also:
-
getPopupKeyTip
Returns the key tip for the popup area of the command button that represents this menu entry.- Returns:
- The key tip for the popup area of the command button that represents this menu entry.
- See Also:
-
setPopupKeyTip
Sets the new value for the key tip for the popup area of the command button that represents this menu entry.- Parameters:
popupKeyTip
- The new value for the key tip for the popup area of the command button that represents this menu entry.- See Also:
-
getActionRichTooltip
Returns the rich tooltip for the action area of the command button that represents this menu entry.- Returns:
- The rich tooltip for the action area of the command button that represents this menu entry.
- See Also:
-
#setPopupTooltip(RichTooltip)
getActionRichTooltip()
-
setActionRichTooltip
Sets the rich tooltip for the action area of the command button that represents this menu entry.- Parameters:
actionRichTooltip
- The rich tooltip for the action area of the command button that represents this menu entry.- See Also:
-
getActionRichTooltip()
#setActionTooltip(RichTooltip)
-
getPopupRichTooltip
Returns the rich tooltip for the popup area of the command button that represents this menu entry.- Returns:
- The rich tooltip for the popup area of the command button that represents this menu entry.
- See Also:
-
#setPopupTooltip(RichTooltip)
getActionRichTooltip()
-
setPopupRichTooltip
Sets the rich tooltip for the popup area of the command button that represents this menu entry.- Parameters:
popupRichTooltip
- The rich tooltip for the popup area of the command button that represents this menu entry.- See Also:
-
getPopupRichTooltip()
#setActionTooltip(RichTooltip)
-
getDisabledIcon
Returns the disabled icon for the command button that represents this menu entry.- Returns:
- The disabled icon for the command button that represents this menu entry.
- See Also:
-
setDisabledIcon
Sets the disabled icon for the command button that represents this menu entry.- Parameters:
disabledIcon
- The disabled icon for the command button that represents this menu entry.- See Also:
-