net.sf.basedb.clients.web.extensions.menu
Class FixedMenuItemFactory

java.lang.Object
  net.sf.basedb.clients.web.extensions.AbstractJspFactory
      net.sf.basedb.clients.web.extensions.AbstractJspActionFactory<MenuItemAction>
          net.sf.basedb.clients.web.extensions.menu.FixedMenuItemFactory

All Implemented Interfaces:

MenuItemAction, Action, ActionFactory<MenuItemAction>

public class FixedMenuItemFactory
extends AbstractJspActionFactory<MenuItemAction>
implements MenuItemAction

A simple implementation of a menu item action factory that creates the same fixed menu item for all users not using any context information.

The menu is by default a regular menuitem and is both visible and enabled. Use the setter method to change the properties. Changes to the properties are immediately visible in the menu items returned from the getActions(InvokationContext) method.

Version:

2.7

Author:

nicklas

Last modified

$Date:2008-03-20 12:15:25 +0100 (Thu, 20 Mar 2008) $

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.basedb.clients.web.extensions.menu.MenuItemAction

MenuItemAction.MenuType

Field Summary

private MenuItemAction[]	actions
private boolean	enabled
private String	icon
private String	menuId
private String	onClick
private String	style
private String	submenuId
private String	title
private String	tooltip
private MenuItemAction.MenuType	type
private boolean	visible

Constructor Summary

FixedMenuItemFactory()
Create a new factory instance.

Method Summary

MenuItemAction[]	getActions(InvokationContext<? super MenuItemAction> context) This method may be called one or several times for each request.
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.
void	setEnabled(boolean enabled)
void	setEnabled(String enabled)
void	setIcon(String icon)
void	setMenuId(String menuId)
void	setOnClick(String onClick)
void	setStyle(String style)
void	setSubmenuId(String submenuId)
void	setTitle(String title)
void	setTooltip(String tooltip)
void	setType(MenuItemAction.MenuType type)
void	setType(String type)
void	setVisible(boolean visible)
void	setVisible(String visible)

Methods inherited from class net.sf.basedb.clients.web.extensions.AbstractJspActionFactory

prepareContext

Methods inherited from class net.sf.basedb.clients.web.extensions.AbstractJspFactory

getScripts, getStylesheets, prepareContext, setScript, setStylesheet

Methods inherited from class java.lang.Object

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

Field Detail

actions

private MenuItemAction[] actions

menuId

private String menuId

submenuId

private String submenuId

icon

private String icon

onClick

private String onClick

style

private String style

title

private String title

tooltip

private String tooltip

enabled

private boolean enabled

visible

private boolean visible

type

private MenuItemAction.MenuType type

Constructor Detail

FixedMenuItemFactory

public FixedMenuItemFactory()

Create a new factory instance.

Method Detail

getActions

public MenuItemAction[] getActions(InvokationContext<? super MenuItemAction> context)

Description copied from interface: ActionFactory

This method may be called one or several times for each request. This is decided by the extension point. If, for example, the extension point is a pure single-item extension point then this method is probably only called once. If the extension point is a per-item extension point in a list context, then this method may be called once for every item in the list. The context parameter contains all information about the context of the extension point, including the current item, if any.

Specified by:

getActions in interface ActionFactory<MenuItemAction>

Parameters:

context - The current invokation context

Returns:

An array of actions that should be added to the extension point. Returns null or an empty array if there are no actions in the current context.

getIcon

public String getIcon()

Description copied from interface: MenuItemAction

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.

Specified by:

getIcon in interface MenuItemAction

Returns:

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

getMenuId

public String getMenuId()

Description copied from interface: MenuItemAction

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

Specified by:

getMenuId in interface MenuItemAction

getOnClick

public String getOnClick()

Description copied from interface: MenuItemAction

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.

Specified by:

getOnClick in interface MenuItemAction

Returns:

The javascript action

getStyle

public String getStyle()

Description copied from interface: MenuItemAction

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

Specified by:

getStyle in interface MenuItemAction

Returns:

Style attributes, or null

getSubmenuId

public String getSubmenuId()

Description copied from interface: MenuItemAction

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

Specified by:

getSubmenuId in interface MenuItemAction

getTitle

public String getTitle()

Description copied from interface: MenuItemAction

Get the title of the menu.

Specified by:

getTitle in interface MenuItemAction

getTooltip

public String getTooltip()

Description copied from interface: MenuItemAction

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

Specified by:

getTooltip in interface MenuItemAction

Returns:

The tooltip or null to not display any tooltip

getType

public MenuItemAction.MenuType getType()

Description copied from interface: MenuItemAction

The type of menu item.

Specified by:

getType in interface MenuItemAction

isEnabled

public boolean isEnabled()

Description copied from interface: MenuItemAction

If the menu item should be enabled or disabled.

Specified by:

isEnabled in interface MenuItemAction

isVisible

public boolean isVisible()

Description copied from interface: MenuItemAction

If the menu item should be visible or not.

Specified by:

isVisible in interface MenuItemAction

setIcon

@VariableSetter
@PathSetter
public void setIcon(String icon)

setMenuId

public void setMenuId(String menuId)

setOnClick

@VariableSetter
public void setOnClick(String onClick)

setStyle

public void setStyle(String style)

setSubmenuId

public void setSubmenuId(String submenuId)

setTitle

public void setTitle(String title)

setTooltip

public void setTooltip(String tooltip)

setEnabled

public void setEnabled(boolean enabled)

setEnabled

public void setEnabled(String enabled)

setVisible

public void setVisible(boolean visible)

setVisible

public void setVisible(String visible)

setType

public void setType(MenuItemAction.MenuType type)

setType

public void setType(String type)