FixedMenuItemFactory (BASE 3.11.1 API documentation)

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:

DynamicActionAttributes, 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

Fields
Modifier and Type	Field and Description
`private MenuItemAction[]`	`actions`
`private String`	`clazz`
`private boolean`	`enabled`
`private String`	`icon`
`private String`	`id`
`private String`	`menuId`
`private String`	`style`
`private String`	`submenuId`
`private String`	`title`
`private String`	`tooltip`
`private MenuItemAction.MenuType`	`type`
`private boolean`	`visible`

Constructor Summary

Constructors
Constructor and Description

FixedMenuItemFactory()
Create a new factory instance.

Constructors
Constructor and Description
`FixedMenuItemFactory()` Create a new factory instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MenuItemAction[]`	`getActions(InvokationContext<? super MenuItemAction> context)` This method may be called one or several times for each request.
`String`	`getClazz()` Class attribute to add to the main menu tag.
`String`	`getIcon()` Get an absolute reference to an image that will be displayed in the menu.
`String`	`getId()` ID attribute of the main menu tag.
`String`	`getMenuId()` The ID of the menu where this menu item belongs, or null if it belongs to the top-level 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`	`setClazz(String clazz)`
`void`	`setEnabled(boolean enabled)`
`void`	`setEnabled(String enabled)`
`void`	`setIcon(String icon)`
`void`	`setId(String id)`
`void`	`setMenuId(String menuId)`
`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
getDynamicActionAttributes, getParameter, getScripts, getStylesheets, prepareContext, setParameter, 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
```
  - id
```
private String id
```
  - clazz
```
private String clazz
```
  - menuId
```
private String menuId
```
  - submenuId
```
private String submenuId
```
  - icon
```
private String icon
```
  - 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.
  - getId
```
public String getId()
```
    Description copied from interface: MenuItemAction
    
    ID attribute of the main menu tag. You need to set this value to reference the menu item in a javascript.
    
    Specified by:
    
    getId in interface MenuItemAction
    
    Returns:
    
    The ID, or null
  - getClazz
```
public String getClazz()
```
    Description copied from interface: MenuItemAction
    
    Class attribute to add to the main menu tag.
    
    Specified by:
    
    getClazz in interface MenuItemAction
  - 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
  - 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
  - setId
```
public void setId(String id)
```
  - setClazz
```
public void setClazz(String clazz)
```
  - setIcon
```
@VariableSetter
 @PathSetter
public void setIcon(String icon)
```
  - setMenuId
```
public void setMenuId(String menuId)
```
  - 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)
```

Class FixedMenuItemFactory

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

actions

id

clazz

menuId

submenuId

icon

style

title

tooltip

enabled

visible

type

Constructor Detail

FixedMenuItemFactory

Method Detail

getActions

getId

getClazz

getIcon

getMenuId

getStyle

getSubmenuId

getTitle

getTooltip

getType

isEnabled

isVisible

setId

setClazz

setIcon

setMenuId

setStyle

setSubmenuId

setTitle

setTooltip

setEnabled

setEnabled

setVisible

setVisible

setType

setType