Class FixedMenuItemFactory

    • 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
      • 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
      • 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
      • 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)
      • 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​(String type)