Class RibbonApplicationMenu

java.lang.Object
org.pushingpixels.flamingo.api.ribbon.RibbonApplicationMenu

public class RibbonApplicationMenu extends Object
Metadata description of the application menu of the JRibbon component. The ribbon application menu has three parts:
 +-------------------------------------+
 |           |                         |
 |           |                         |
 |  primary  |        secondary        |
 |   area    |           area          |        
 |           |                         |
 |           |                         |
 |-------------------------------------|
 |            footer area              |
 +-------------------------------------+
 

The entries in the primary area are always visible. The secondary area entries are shown based on the currently active element in the primary area. There are three different types of primary entries:

At runtime, the application menu entries are implemented as JCommandMenuButton, but the application code does not operate on that level. Instead, the application code creates metadata-driven description of the ribbon application menu, and that description is used to create and populate the "real" controls of the application menu popup.

Note that once a RibbonApplicationMenu is set on the JRibbon with the JRibbon.setApplicationMenu(RibbonApplicationMenu), its contents cannot be changed. An IllegalStateException will be thrown from addMenuEntry(RibbonApplicationMenuEntryPrimary) and addFooterEntry(RibbonApplicationMenuEntryFooter).