org.pentaho.platform.web.html
Class HtmlMenuProvider

java.lang.Object
  org.pentaho.platform.plugin.services.pluginmgr.BaseMenuProvider
      org.pentaho.platform.web.html.HtmlMenuProvider

All Implemented Interfaces:

IMenuProvider

public class HtmlMenuProvider
extends BaseMenuProvider

Constructor Summary

HtmlMenuProvider()

Method Summary

String	getMenuBar(String id, String documentPath, IPentahoSession session) Returns a menu bar object.
String	getPopupMenu(String id, String documentPath, IPentahoSession session) Returns a popup menu object.

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlMenuProvider

public HtmlMenuProvider()

Method Detail

getMenuBar

public String getMenuBar(String id,
                         String documentPath,
                         IPentahoSession session)

Description copied from interface: IMenuProvider

Returns a menu bar object. The type of the object returned will depend upon the implementor.

Specified by:

getMenuBar in interface IMenuProvider

Specified by:

getMenuBar in class BaseMenuProvider

Parameters:

id - The id of the menu to be returned. The menu will to be defined in a XUL file e.g. pentaho-solutions/system/ui/menubar.xul

documentPath - The path to the file that contains the definition of the menu e.g. system/ui/menubar.xul

session - A session object that the IMenuProvider can use to filter the menu items returned

Returns:

A menu bar object

getPopupMenu

public String getPopupMenu(String id,
                           String documentPath,
                           IPentahoSession session)

Description copied from interface: IMenuProvider

Returns a popup menu object. The type of the object returned will depend upon the implementor.

Specified by:

getPopupMenu in interface IMenuProvider

Specified by:

getPopupMenu in class BaseMenuProvider

Parameters:

id - The id of the menu to be returned. The menu will to be defined in a XUL file e.g. pentaho-solutions/system/ui/menubar.xul

documentPath - The path to the file that contains the definition of the menu e.g. system/ui/menubar.xul

session - A session object that the IMenuProvider can use to filter the menu items returned

Returns:

A menu bar object