org.pentaho.platform.plugin.services.pluginmgr
Class BaseMenuProvider

java.lang.Object
  org.pentaho.platform.plugin.services.pluginmgr.BaseMenuProvider

All Implemented Interfaces:

IMenuProvider

Direct Known Subclasses:

HtmlMenuProvider

public abstract class BaseMenuProvider
extends java.lang.Object
implements IMenuProvider

Constructor Summary

BaseMenuProvider()

Method Summary

abstract java.lang.Object	getMenuBar(java.lang.String id, java.lang.String documentPath, IPentahoSession session) Returns a menu bar object.
abstract java.lang.Object	getPopupMenu(java.lang.String id, java.lang.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

BaseMenuProvider

public BaseMenuProvider()

Method Detail

getMenuBar

public abstract java.lang.Object getMenuBar(java.lang.String id,
                                            java.lang.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

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 abstract java.lang.Object getPopupMenu(java.lang.String id,
                                              java.lang.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

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