Package org.pushingpixels.flamingo.api.ribbon

Class RibbonApplicationMenuPrimaryCommand

java.lang.Object

org.pushingpixels.flamingo.api.common.FlamingoCommand

org.pushingpixels.flamingo.api.ribbon.RibbonApplicationMenuPrimaryCommand

public class RibbonApplicationMenuPrimaryCommand
extends FlamingoCommand

Metadata description for the primary menu entries of the RibbonApplicationMenu. The primary menu entries at runtime are represented by command menu buttons placed in the leading panel of the application menu.

There are two different types of primary entries:

• Associated RibbonApplicationMenuPrimaryCommand.PrimaryRolloverCallback. When this entry is armed (with mouse rollover or via keyboard navigation), the contents of the secondary area are populated by the application callback implementation of RibbonApplicationMenuPrimaryCommand.PrimaryRolloverCallback.menuEntryActivated(javax.swing.JPanel). The Open menu item is an example of such a primary menu entry, showing a list of recently opened files. For a primary entry that is action-only, pass RibbonApplicationMenuPrimaryCommand.PrimaryClearRolloverCallback as the primary rollover callback to clear the secondary area.
• Associated list of FlamingoCommands. When this entry is armed (with mouse rollover or via keyboard navigation), the secondary area shows menu buttons for the registered secondary menu commands. The Save As menu item is an example of such a primary menu item, showing a list of default save formats.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RibbonApplicationMenuPrimaryCommand.PrimaryClearRolloverCallback
static interface	RibbonApplicationMenuPrimaryCommand.PrimaryRolloverCallback	Callback that allows application code to provide custom content on the secondary panel of the RibbonApplicationMenu.
static class	RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder

Nested classes/interfaces inherited from class org.pushingpixels.flamingo.api.common.FlamingoCommand

FlamingoCommand.BaseFlamingoCommandBuilder<T extends FlamingoCommand,B extends FlamingoCommand.BaseFlamingoCommandBuilder>, FlamingoCommand.FlamingoCommandBuilder, FlamingoCommand.FlamingoCommandToggleGroup

Method Summary

Modifier and Type	Method	Description
RibbonApplicationMenuPrimaryCommand.PrimaryRolloverCallback	getRolloverCallback()	Returns the current application callback that allows placing custom content in the secondary panel of the RibbonApplicationMenu when this primary menu entry is activated.
java.util.List<FlamingoCommand>	getSecondaryGroupCommands(int groupIndex)	Returns an unmodifiable list of commands of the secondary menu group at the specified index.
int	getSecondaryGroupCount()	Returns the number of secondary menu groups of this primary menu entry.
java.lang.String	getSecondaryGroupTitleAt(int groupIndex)	Returns the title of the secondary menu group at the specified index.
protected boolean	hasAction()
protected boolean	hasPopup()

Methods inherited from class org.pushingpixels.flamingo.api.common.FlamingoCommand

buildButton, buildMenuButton, checkConsistency, getAction, getActionKeyTip, getActionRichTooltip, getAutoRepeatInitialInterval, getAutoRepeatSubsequentInterval, getDisabledIcon, getExtraText, getIcon, getPopupCallback, getPopupKeyTip, getPopupOrientationKind, getPopupRichTooltip, getTitle, getToggleGroup, isAutoRepeatAction, isEnabled, isFireActionOnRollover, isTitleClickAction, isTitleClickPopup, isToggle, isToggleSelected, setEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSecondaryGroupCount

public int getSecondaryGroupCount()

Returns the number of secondary menu groups of this primary menu entry.

Returns:

The number of secondary menu groups of this primary menu entry.

See Also:

getSecondaryGroupTitleAt(int), getSecondaryGroupCommands(int)

getSecondaryGroupTitleAt

public java.lang.String getSecondaryGroupTitleAt(int groupIndex)

Returns the title of the secondary menu group at the specified index.

Parameters:

groupIndex - The index of a secondary menu group.

Returns:

The title of the secondary menu group at the specified index.

See Also:

getSecondaryGroupCount(), getSecondaryGroupCommands(int)

getSecondaryGroupCommands

public java.util.List<FlamingoCommand> getSecondaryGroupCommands(int groupIndex)

Returns an unmodifiable list of commands of the secondary menu group at the specified index.

Parameters:

groupIndex - The index of a secondary menu group.

Returns:

An unmodifiable list of commands of the secondary menu group at the specified index.

See Also:

getSecondaryGroupCount(), getSecondaryGroupTitleAt(int)

getRolloverCallback

public RibbonApplicationMenuPrimaryCommand.PrimaryRolloverCallback getRolloverCallback()

Returns the current application callback that allows placing custom content in the secondary panel of the RibbonApplicationMenu when this primary menu entry is activated.

Returns:

The current rollover callback for populating the secondary panel of the RibbonApplicationMenu.

hasAction

protected boolean hasAction()

Overrides:

hasAction in class FlamingoCommand

hasPopup

protected boolean hasPopup()

Overrides:

hasPopup in class FlamingoCommand