Package org.pentaho.mantle.client.ui

Class BurgerMenuBar

  • All Implemented Interfaces:
    com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasCloseHandlers<com.google.gwt.user.client.ui.PopupPanel>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasAnimation, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.PopupListener, EventListener
    public class BurgerMenuBar
extends com.google.gwt.user.client.ui.MenuBar
    Extension of MenuBar, the BurgerMenuBar is a compact version of the PUC menus

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  BurgerMenuBar.BurgerBackMenuItem  

      • Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.MenuBar

        com.google.gwt.user.client.ui.MenuBar.MenuBarImages, com.google.gwt.user.client.ui.MenuBar.Resources

      • Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

        com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

    • Field Summary

      • Fields inherited from class com.google.gwt.user.client.ui.UIObject

        DEBUG_ID_PREFIX

    • Constructor Summary

      Constructors 
      Constructor Description
      BurgerMenuBar()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addBackItemToDescendantMenus()
      Adds a "back" menu item to each descendant menu bar.
      protected void closeLocal​(boolean focus)
      Local version of MenuBar private super.close( boolean )
      protected void closeRoot()  
      protected void doItemActionLocal​(com.google.gwt.user.client.ui.MenuItem item, boolean fireCommand, boolean focus)
      Local, adapted version of MenuBar private super.doItemAction(MenuItem, boolean, boolean).
      protected void eatEventLocal​(com.google.gwt.user.client.Event event)
      Local version of MenuBar private super.eatEvent( Event )
      protected void ensureVisible​(com.google.gwt.user.client.ui.MenuItem menuItem)  
      protected com.google.gwt.user.client.ui.MenuItem findItemLocal​(com.google.gwt.dom.client.Element hItem)
      Local version of MenuBar private super.findItem( Element )
      protected BurgerMenuBar getMenuBarParent()
      Access to MenuBar private field super.parentMenu
      protected com.google.gwt.user.client.ui.DecoratedPopupPanel getMenuBarPopup()
      Access to MenuBar private field super.popup
      protected BurgerMenuBar getRootMenu()  
      protected com.google.gwt.user.client.ui.PopupPanel getRootPopup()  
      void onBrowserEvent​(com.google.gwt.user.client.Event event)  
      protected void onEnter()  
      protected void onEscape()  

      • Methods inherited from class com.google.gwt.user.client.ui.MenuBar

        addCloseHandler, addItem, addItem, addItem, addItem, addItem, addItem, addItem, addSeparator, addSeparator, clearItems, closeAllChildren, focus, getAutoOpen, getItemIndex, getItems, getSelectedItem, getSeparatorIndex, insertItem, insertSeparator, insertSeparator, isAnimationEnabled, isFocusOnHoverEnabled, moveSelectionDown, moveSelectionUp, onDetach, onEnsureDebugId, onPopupClosed, removeItem, removeSeparator, selectItem, setAnimationEnabled, setAutoOpen, setFocusOnHoverEnabled

      • Methods inherited from class com.google.gwt.user.client.ui.Widget

        addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

      • Methods inherited from class com.google.gwt.user.client.ui.UIObject

        addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

      • Methods inherited from interface com.google.gwt.event.shared.HasHandlers

        fireEvent

    • Constructor Detail

      • BurgerMenuBar

        public BurgerMenuBar()

    • Method Detail

      • onBrowserEvent

        public void onBrowserEvent​(com.google.gwt.user.client.Event event)
        Specified by:
        onBrowserEvent in interface com.google.gwt.user.client.EventListener
        Overrides:
        onBrowserEvent in class com.google.gwt.user.client.ui.MenuBar

      • onEscape

        protected void onEscape()

      • onEnter

        protected void onEnter()

      • ensureVisible

        protected void ensureVisible​(com.google.gwt.user.client.ui.MenuItem menuItem)

      • addBackItemToDescendantMenus

        public void addBackItemToDescendantMenus()
        Adds a "back" menu item to each descendant menu bar.

        Should be called on the root of the subtree, once it's fully built, or when there have been modifications to it.

        See Also:
        BurgerMenuBar.BurgerBackMenuItem

      • closeRoot

        protected void closeRoot()

      • getRootPopup

        protected com.google.gwt.user.client.ui.PopupPanel getRootPopup()

      • findItemLocal

        protected com.google.gwt.user.client.ui.MenuItem findItemLocal​(com.google.gwt.dom.client.Element hItem)
        Local version of MenuBar private super.findItem( Element )

      • eatEventLocal

        protected void eatEventLocal​(com.google.gwt.user.client.Event event)
        Local version of MenuBar private super.eatEvent( Event )
        Parameters:
        event - Event to eat

      • closeLocal

        protected void closeLocal​(boolean focus)
        Local version of MenuBar private super.close( boolean )
        Parameters:
        focus - boolean value determining if focus is applied to parent after closing

      • doItemActionLocal

        protected void doItemActionLocal​(com.google.gwt.user.client.ui.MenuItem item,
                                 boolean fireCommand,
                                 boolean focus)
        Local, adapted version of MenuBar private super.doItemAction(MenuItem, boolean, boolean). Overrides the command execution of a menu item closes the whole menu (unlike closeAllParents()). Additionally, the special back menu items do not cause the menu to close.
        Parameters:
        item - MenuItem whose action is to be performed
        fireCommand - boolean determining if command is to be fired
        focus - boolean determining if focus should be applied to parent MenuBar

      • getMenuBarPopup

        protected com.google.gwt.user.client.ui.DecoratedPopupPanel getMenuBarPopup()
        Access to MenuBar private field super.popup

      • getMenuBarParent

        protected BurgerMenuBar getMenuBarParent()
        Access to MenuBar private field super.parentMenu