Package com.microstrategy.web.app.taglibs

Class ContextMenusTag

  • All Implemented Interfaces:
    java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
    public class ContextMenusTag
extends AbstractBodyTag
    This custom tag adds context-menus to an area of the page. That is, a pop-up menu will be displayed to the user when s/he right-mouse clicks in the page within the body of the Tag.
    The menus need to be defined in the pageConfig.xml in the <menus> section. These are defined as a shortcut-list-set. The Tag will automatically use the first shortcut-list.
    To render a context-menus only its name is required (as specified in the page-config). Optionally, a "baseBean" can be provided, which tells the menus where to check for Features and the Events.
    Since:
    MicroStrategy Web 8.0.0
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

        bodyContent

      • Fields inherited from class javax.servlet.jsp.tagext.TagSupport

        id, pageContext

      • Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

        EVAL_BODY_BUFFERED, EVAL_BODY_TAG

      • Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

        EVAL_BODY_AGAIN

      • Fields inherited from interface javax.servlet.jsp.tagext.Tag

        EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

    • Constructor Summary

      Constructors 
      Constructor Description
      ContextMenusTag()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AbstractBodyTagHelper getHelper()
      Method for retrieving the helper related with the tag.
      void setBaseBean​(java.lang.String value)
      This refers to the name of the Bean to used as the Component for the GuiElement.
      void setMenusName​(java.lang.String value)
      Indicates the name of the menu in the page-config to be used for context-menus.
      void setName​(java.lang.String value)
      Indicates the name of the context-menu in the page.

      • Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

        doInitBody, getBodyContent, getPreviousOut, setBodyContent

      • Methods inherited from class javax.servlet.jsp.tagext.TagSupport

        findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface javax.servlet.jsp.tagext.Tag

        getParent, setPageContext, setParent

    • Constructor Detail

      • ContextMenusTag

        public ContextMenusTag()

    • Method Detail

      • setName

        public void setName​(java.lang.String value)
        Indicates the name of the context-menu in the page.
        Usage:
        This attributes helps the JavaScript code to identify the context menus within the page. It needs to be a unique identifier for the menus. If not specified, one will be automatically assigned.
        Parameters:
        value - String value with the name for the context-menus.

      • setMenusName

        public void setMenusName​(java.lang.String value)
        Indicates the name of the menu in the page-config to be used for context-menus.
        Usage:
        The name needs to be a valid shortcut-list-set of the <menus> section in the page-config.
        Parameters:
        value - String the name of menu.

      • setBaseBean

        public void setBaseBean​(java.lang.String value)
        This refers to the name of the Bean to used as the Component for the GuiElement.
        The GuiElement then uses this bean to retrieve information such as Features and Events.
        Parameters:
        value - String value with the name of the bean to use as base bean.