Package org.pushingpixels.flamingo.api.ribbon

Class RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder

java.lang.Object

org.pushingpixels.flamingo.api.common.FlamingoCommand.BaseFlamingoCommandBuilder<RibbonApplicationMenuPrimaryCommand,RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder>

org.pushingpixels.flamingo.api.ribbon.RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder

Enclosing class:

RibbonApplicationMenuPrimaryCommand

public static class RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder
extends FlamingoCommand.BaseFlamingoCommandBuilder<RibbonApplicationMenuPrimaryCommand,RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder>

Field Summary

Fields inherited from class org.pushingpixels.flamingo.api.common.FlamingoCommand.BaseFlamingoCommandBuilder

action, actionKeyTip, actionRichTooltip, autoRepeatInitialInterval, autoRepeatSubsequentInterval, disabledIcon, extraText, hasAutoRepeatIntervalsSet, icon, isAutoRepeatAction, isEnabled, isFireActionOnRollover, isTitleClickAction, isTitleClickPopup, isToggle, isToggleSelected, popupCallback, popupKeyTip, popupOrientationKind, popupRichTooltip, title, toggleGroup

Constructor Summary

Constructors

Constructor	Description
RibbonApplicationMenuPrimaryCommandBuilder()

Method Summary

Modifier and Type	Method	Description
RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder	addSecondaryMenuGroup(java.lang.String groupTitle, java.lang.Iterable<FlamingoCommand> secondaryCommands)	Adds a titled group of secondary menu commands.
RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder	addSecondaryMenuGroup(java.lang.String groupTitle, FlamingoCommand... secondaryCommands)	Adds a titled group of secondary menu commands.
RibbonApplicationMenuPrimaryCommand	build()
RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder	setRolloverCallback(RibbonApplicationMenuPrimaryCommand.PrimaryRolloverCallback rolloverCallback)	Sets the rollover callback that allows the application to place custom content in the secondary panel of the RibbonApplicationMenu when this primary menu entry is activated.
RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder	setSecondaryGroupTitle(int groupIndex, java.lang.String newTitle)	Changes the title of the specified group.

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

configureBaseCommand, inToggleGroup, setAction, setActionKeyTip, setActionRichTooltip, setAutoRepeatAction, setAutoRepeatActionIntervals, setDisabledIcon, setEnabled, setExtraText, setFireActionOnRollover, setIcon, setPopupCallback, setPopupKeyTip, setPopupOrientationKind, setPopupRichTooltip, setTitle, setTitleClickAction, setTitleClickPopup, setToggle, setToggleSelected

Methods inherited from class java.lang.Object

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

Constructor Detail

RibbonApplicationMenuPrimaryCommandBuilder

public RibbonApplicationMenuPrimaryCommandBuilder()

Method Detail

addSecondaryMenuGroup

public RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder addSecondaryMenuGroup(java.lang.String groupTitle,
                                                                                                            FlamingoCommand... secondaryCommands)

Adds a titled group of secondary menu commands.

Parameters:

groupTitle - The title of the group.

secondaryCommands - The secondary menu commands belonging to this group.

addSecondaryMenuGroup

public RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder addSecondaryMenuGroup(java.lang.String groupTitle,
                                                                                                            java.lang.Iterable<FlamingoCommand> secondaryCommands)

Adds a titled group of secondary menu commands.

Parameters:

groupTitle - The title of the group.

secondaryCommands - The secondary menu commands belonging to this group.

setRolloverCallback

public RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder setRolloverCallback(RibbonApplicationMenuPrimaryCommand.PrimaryRolloverCallback rolloverCallback)

Sets the rollover callback that allows the application to place custom content in the secondary panel of the RibbonApplicationMenu when this primary menu entry is activated.

Parameters:

rolloverCallback - The new rollover callback for populating the secondary panel of the RibbonApplicationMenu.

setSecondaryGroupTitle

public RibbonApplicationMenuPrimaryCommand.RibbonApplicationMenuPrimaryCommandBuilder setSecondaryGroupTitle(int groupIndex,
                                                                                                             java.lang.String newTitle)

Changes the title of the specified group.

Parameters:

groupIndex - Group index.

newTitle - New title for the specified group.

build

public RibbonApplicationMenuPrimaryCommand build()