org.pushingpixels.flamingo.api.ribbon
Class RibbonApplicationMenuEntryFooter

java.lang.Object
  extended by org.pushingpixels.flamingo.api.ribbon.RibbonApplicationMenuEntryFooter

public class RibbonApplicationMenuEntryFooter
extends java.lang.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 Summary
protected  java.lang.String actionKeyTip
          Optional key tip 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  java.lang.String text
          The menu text.
 
Constructor Summary
RibbonApplicationMenuEntryFooter(ResizableIcon icon, java.lang.String text, java.awt.event.ActionListener mainActionListener)
          Creates the metadata description of a RibbonApplicationMenu footer menu entry.
 
Method Summary
 java.lang.String getActionKeyTip()
          Returns the key tip 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.
 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 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 setText(java.lang.String text)
          Sets the new text for this application menu entry.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

icon

protected ResizableIcon icon
The menu icon.


disabledIcon

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


text

protected java.lang.String text
The menu text.


mainActionListener

protected java.awt.event.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 java.lang.String actionKeyTip
Optional key tip for the action area of the command button that represents this menu entry.


popupKeyTip

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

Constructor Detail

RibbonApplicationMenuEntryFooter

public RibbonApplicationMenuEntryFooter(ResizableIcon icon,
                                        java.lang.String text,
                                        java.awt.event.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 Detail

getIcon

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

Returns:
The icon of this application menu entry.

getText

public java.lang.String getText()
Returns the text of this application menu entry.

Returns:
The text of this application menu entry.
See Also:
setText(String)

setText

public void setText(java.lang.String text)
Sets the new text for this application menu entry.

Parameters:
text - The new text for this application menu entry.
See Also:
getText()

getMainActionListener

public java.awt.event.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

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 java.lang.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(String), getPopupKeyTip()

setActionKeyTip

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

Parameters:
actionKeyTip - The new value for the key tip for the action area of the command button that represents this menu entry.
See Also:
getActionKeyTip(), setPopupKeyTip(String)

getPopupKeyTip

public java.lang.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(String), getActionKeyTip()

setPopupKeyTip

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

Parameters:
popupKeyTip - The new value for the key tip for the popup area of the command button that represents this menu entry.
See Also:
getPopupKeyTip(), setActionKeyTip(String)

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(ResizableIcon)

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:
getDisabledIcon()