net.sf.basedb.clients.web.extensions.menu
Interface MenuItemAction

All Superinterfaces:

Action

All Known Implementing Classes:

FixedMenuItemFactory, MenuItemBean

public interface MenuItemAction
extends Action

An action for extensions to the menu system. The extension point will add menu items to the Extensions menu.

There are three types of menu items:

• A regular menu item, which is usually associated with some kind of action when the user clicks on it.
• A separator item. It's just for visual appearance. It is never associated with any action.
• A submenu item, which opens up a submenu when the user selects it. A submenu must specify a getSubmenuId(). Regular menu items can be put into the submenu item by specifying the same id for getMenuId().

Version:

2.7

Author:

nicklas

Last modified

$Date: 2009-03-24 09:22:28 +0100 (Tue, 24 Mar 2009) $

Nested Class Summary

static class

MenuItemAction.MenuType

Method Summary

String	getIcon() Get an absolute reference to an image that will be displayed in the menu.
String	getMenuId() The ID of the menu where this menu item belongs, or null if it belongs to the top-level menu.
String	getOnClick() A javascript action that is executed when the user clicks the menu.
String	getStyle() Extra CSS style attributes that will be added to the style attribute of the menu item div.
String	getSubmenuId() The ID of a new submenu.
String	getTitle() Get the title of the menu.
String	getTooltip() A tooltip that is shown as a yellow popup when the user points the mouse at the menu item.
MenuItemAction.MenuType	getType() The type of menu item.
boolean	isEnabled() If the menu item should be enabled or disabled.
boolean	isVisible() If the menu item should be visible or not.

Method Detail

getType

MenuItemAction.MenuType getType()

The type of menu item.

getMenuId

String getMenuId()

The ID of the menu where this menu item belongs, or null if it belongs to the top-level menu.

getSubmenuId

String getSubmenuId()

The ID of a new submenu. This value is required when the menu item is a MenuItemAction.MenuType.SUBMENU, and is ignored otherwise.

getTitle

String getTitle()

Get the title of the menu.

getTooltip

String getTooltip()

A tooltip that is shown as a yellow popup when the user points the mouse at the menu item.

Returns:

The tooltip or null to not display any tooltip

getIcon

String getIcon()

Get an absolute reference to an image that will be displayed in the menu. It is recommended that the image is 9 pixels wide and 12 pixels high to line up with the icons used by the BASE core menus.

Returns:

A reference to an image, or null if no image should be used

getStyle

String getStyle()

Extra CSS style attributes that will be added to the style attribute of the menu item div.

Returns:

Style attributes, or null

isEnabled

boolean isEnabled()

If the menu item should be enabled or disabled.

isVisible

boolean isVisible()

If the menu item should be visible or not.

getOnClick

String getOnClick()

A javascript action that is executed when the user clicks the menu. BASE has builtin scripts for opening a page in a popup window or opening a page in the main window:

• To open a page in the main window use: Menu.openUrl(url)

  The URL can be any valid URL. To access a JSP page on the BASE server you need to know the root path of the web application and the session ID for the logged in user. This information available in the JspContext passed to the factory class. If you, for example, want to open the reporters list page, you can create the URL like this:

  String url = jspContext.getRoot() + 
     "/views/reporters/index.jsp?ID=" + 
     jspContext.getSessionControl().getId();
  

  It is also possible to use pure JavaScript to extract the root URL and session ID. Here is an example that opens the reporter list page:

  Menu.openUrl(getRoot()+'views/reporters/index.jsp?ID='+getSessionId());
  

  Another possibility that works for the root path is to use a factory that has enabled variable substitution. In this case you can use:

  Menu.openUrl('$ROOT$/views/reporters/index.jsp?ID='+getSessionId());
  

• To open a popup window use: Main.openPopup(url, windowName, width, height, options)

  The URL follows the same rules as the above. The windowName is a name to give to the popup window. Use only alphabetical characters (a-z). The size is controlled with the width and height options, given in pixels. BASE will automatically rescale the window if the user has choosen a bigger or smaller font size. Other options can be specified in the options parameter. See documentation for the window.open() javascript function for valid syntax.

Returns:

The javascript action