org.pentaho.platform.api.ui
Interface IMenuProvider

All Known Implementing Classes:

BaseMenuProvider, HtmlMenuProvider

public interface IMenuProvider

An interface for menu providers

Author:

jamesdixon

Method Summary

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

Method Detail

getMenuBar

java.lang.Object getMenuBar(java.lang.String id,
                            java.lang.String documentPath,
                            IPentahoSession session)

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

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

java.lang.Object getPopupMenu(java.lang.String id,
                              java.lang.String documentPath,
                              IPentahoSession session)

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

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