|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pushingpixels.flamingo.api.ribbon.RibbonApplicationMenuEntrySecondary
public class RibbonApplicationMenuEntrySecondary
Metadata description for the secondary menu entries of the
RibbonApplicationMenu
. The secondary menu entries at runtime are
represented by command menu buttons placed in the right panel of the
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 java.lang.String |
descriptionText
Extra description text for this secondary 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 PopupPanelCallback |
popupCallback
Popup callback 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 | |
---|---|
RibbonApplicationMenuEntrySecondary(ResizableIcon icon,
java.lang.String text,
java.awt.event.ActionListener mainActionListener,
JCommandButton.CommandButtonKind entryKind)
Creates the metadata description of a RibbonApplicationMenu
secondary 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. |
java.lang.String |
getDescriptionText()
Returns the description text of this secondary 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. |
PopupPanelCallback |
getPopupCallback()
Returns the current popup callback of this secondary 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 |
setDescriptionText(java.lang.String descriptionText)
Sets the new description text for this secondary 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 |
setPopupCallback(PopupPanelCallback popupCallback)
Sets the popup callback for this secondary 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 |
---|
protected java.lang.String descriptionText
getDescriptionText()
,
setDescriptionText(String)
protected PopupPanelCallback popupCallback
null
if the
menu entry kind has popup part.
getPopupCallback()
,
setPopupCallback(PopupPanelCallback)
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
Constructor Detail |
---|
public RibbonApplicationMenuEntrySecondary(ResizableIcon icon, java.lang.String text, java.awt.event.ActionListener mainActionListener, JCommandButton.CommandButtonKind entryKind)
RibbonApplicationMenu
secondary menu entry.
icon
- The icon of this menu entry. Must be non-null
.text
- The text of this menu entry. Must be non-null
.mainActionListener
- The main action listener for this menu entry. If the entry
kind is JCommandButton.CommandButtonKind.POPUP_ONLY
, this listener
will be ignored.entryKind
- The kind of the command button that will represent this menu
entry. Must be non- null
.Method Detail |
---|
public java.lang.String getDescriptionText()
setDescriptionText(String)
public void setDescriptionText(java.lang.String descriptionText)
descriptionText
- The new description text for this secondary menu entry.getDescriptionText()
public void setPopupCallback(PopupPanelCallback popupCallback)
popupCallback
- The popup callback for this secondary menu entry.getPopupCallback()
public PopupPanelCallback getPopupCallback()
setPopupCallback(PopupPanelCallback)
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 ResizableIcon getDisabledIcon()
setDisabledIcon(ResizableIcon)
public void setDisabledIcon(ResizableIcon disabledIcon)
disabledIcon
- The disabled icon for the command button that represents this
menu entry.getDisabledIcon()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |