Package net.sf.basedb.clients.web.extensions.menu

Class MenuItemBean

java.lang.Object
net.sf.basedb.clients.web.extensions.DynamicActionAttributeSupport
net.sf.basedb.clients.web.extensions.menu.MenuItemBean
All Implemented Interfaces:
DynamicActionAttributes, MenuItemAction, Action
public class MenuItemBean
extends DynamicActionAttributeSupport
implements MenuItemAction
A simple bean-like implementation of the MenuItemAction interface.
Version:
2.7
Author:
nicklas
Last modified
$Date: 2014-12-09 12:48:21 +0100 (ti, 09 dec 2014) $

  • Field Details

  • Constructor Details

    • MenuItemBean

      public MenuItemBean()
      Create a new empty menu item action.

  • Method Details

    • 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

      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)

    • setVisible

      public void setVisible​(boolean visible)

    • setType

      public void setType​(MenuItemAction.MenuType type)