Package com.onenetwork.platform.common.menu

Interface MenuService

All Superinterfaces:
Service
public interface MenuService
extends Service
Provides methods to use in order to register and use custom MenuResourceListener object. 
 MenuService menuService = Services.get(MenuService.class);
 menuService.registerListener(new MyCustomMenuResourceListener());
 
 MenuAction menuAction = menuService.newMenuAction("MyCustomAction");
 MenuFolder menuFolder = menuService.newMenuFolder("MyCustomFolder");
 MenuPanelOptions panelOptions = menuService.newMenuPanelOptions("One.Report","{autoExecute:true, filter:{name:'test'}}");

  • Method Details

    • registerListener

      void registerListener​(MenuResourceListener listener)
      Any object that extends MenuResourceListener can be registered using registerListener method.
      Parameters:
      listener - - Any object that extends abstract MenuResourceListener class.

    • registerPortletMenuListener

      void registerPortletMenuListener​(PortletMenuResourceListener listener)
      Any object that extends PortletMenuResourceListener can be registered using registerListener method.
      Parameters:
      listener - - Any object that extends abstract PortletMenuResourceListener class.

    • newMenuAction

      MenuAction newMenuAction​(java.lang.String name)
      Generates a new MenuAction object and returns it.
      Parameters:
      name - - name of the action
      Returns:
      MenuAction object.

    • newMenuFolder

      MenuFolder newMenuFolder​(java.lang.String name)
      Generates a new MenuFolder object and returns it.
      Parameters:
      name - - name of the folder.
      Returns:
      MenuFolder object

    • newMenuDivider

      MenuElement newMenuDivider()
      Generates a new MenuDivider object and returns it.
      Returns:

    • newMenuPanelOptions

      MenuPanelOptions newMenuPanelOptions​(java.lang.String panelClass, java.lang.String panelConfig)
      Generates a new MenuPanelOptions object and return it.
      Parameters:
      panelClass - - class of the panel such as JS_PANEL or One.Report.
      panelConfig - - String representation of a json object that has the configuration for the panel
      Returns:
      MenuPanelOptions object.