Package org.pushingpixels.flamingo.api.ribbon

Class RibbonApplicationMenuEntryFooter

java.lang.Object
org.pushingpixels.flamingo.api.ribbon.RibbonApplicationMenuEntryFooter
public class RibbonApplicationMenuEntryFooter extends Object
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 Details

    • icon

      protected ResizableIcon icon
      The menu icon.

    • disabledIcon

      protected ResizableIcon disabledIcon
      The menu icon for disabled state. Optional, can be null.

    • text

      protected String text
      The menu text.

    • mainActionListener

      protected ActionListener mainActionListener
      The main action listener for this menu entry.

    • entryKind

      protected JCommandButton.CommandButtonKind entryKind
      The kind of the command button that represents this menu entry.

    • isEnabled

      protected boolean isEnabled
      Enabled state of this menu.

    • actionKeyTip

      protected String actionKeyTip
      Optional key tip for the action area of the command button that represents this menu entry.

    • popupKeyTip

      protected String popupKeyTip
      Optional key tip for the popup area of the command button that represents this menu entry.

    • actionRichTooltip

      protected RichTooltip actionRichTooltip
      Optional tooltip for the action area of the command button that represents this menu entry.

    • popupRichTooltip

      protected RichTooltip 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 a RibbonApplicationMenu 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 be null, clicking on the matching button will have no effect.

  • Method Details

    • getIcon

      public ResizableIcon getIcon()
      Returns the icon of this application menu entry.
      Returns:
      The icon of this application menu entry.

    • getText

      public String getText()
      Returns the text of this application menu entry.
      Returns:
      The text of this application menu entry.
      See Also:

    • setText

      public void setText(String text)
      Sets the new text for this application menu entry.
      Parameters:
      text - The new text for this application menu entry.
      See Also:

    • getMainActionListener

      public ActionListener getMainActionListener()
      Returns the main action listener associated with this application menu entry.
      Returns:
      The main action listener associated with this application menu entry.

    • getEntryKind

      public JCommandButton.CommandButtonKind 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 - If true, the command button that represents this menu entry will be enabled, if false, 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

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

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

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

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

      public RichTooltip 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:

    • setActionRichTooltip

      public void setActionRichTooltip(RichTooltip actionRichTooltip)
      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:

    • getPopupRichTooltip

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

    • setPopupRichTooltip

      public void setPopupRichTooltip(RichTooltip popupRichTooltip)
      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:

    • getDisabledIcon

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

      public void setDisabledIcon(ResizableIcon disabledIcon)
      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: