Package com.microstrategy.web.app.taglibs

Class ShortcutOptionsTag

  • 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 ShortcutOptionsTag
extends AbstractBodyTag
    Since:
    MicroStrategy Web 7.3.1 or earlier
    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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int doAfterBody()
      This method is called after the JSP engine processes the body content of the tag.
      int doStartTag()
      Process the start tag for this instance.
      AbstractBodyTagHelper getHelper()
      Method for retrieving the helper associated with the tag.
      void setSelected​(java.lang.String value)
      Indicates which element of the shorcut list shall be marked as selected.
      void setShortcutClass​(java.lang.String value)
      Indicates the css class that will be applied to the not-selected element displayed.
      void setShortcutSelectedClass​(java.lang.String value)
      Indicates the class that will be applied to the selected element displayed.
      void setType​(java.lang.String value)
      Indicates the type or name of shortcut list to display.
      void setUcase​(boolean value)
      Indicates the upper case property, for displaying the options all in upper case or as defined in the list.

      • 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

      • ShortcutOptionsTag

        public ShortcutOptionsTag()

    • Method Detail

      • doStartTag

        public int doStartTag()
               throws javax.servlet.jsp.JspException
        Process the start tag for this instance. The doStartTag() method assumes that all setter methods have been invoked before.
        Specified by:
        doStartTag in interface javax.servlet.jsp.tagext.Tag
        Overrides:
        doStartTag in class AbstractBodyTag
        Returns:
        EVAL_BODY_BUFFERED if the tag wants to process body, SKIP_BODY if it does ont want to process it.
        Throws:
        javax.servlet.jsp.JspException - if an error is risen when displaying the custom tag contents

      • doAfterBody

        public int doAfterBody()
                throws javax.servlet.jsp.JspException
        This method is called after the JSP engine processes the body content of the tag. Not invoked in empty tags or in tags returning SKIP_BODY in doStartTag() This method is invoked after every body evaluation.
        Specified by:
        doAfterBody in interface javax.servlet.jsp.tagext.IterationTag
        Overrides:
        doAfterBody in class AbstractBodyTag
        Returns:
        EVAL_BODY_AGAIN if the JSP engine should evaluate the tag body again, otherwise return SKIP_BODY.
        Throws:
        javax.servlet.jsp.JspException - if an error is risen when displaying the custom tag contents

      • setShortcutClass

        public void setShortcutClass​(java.lang.String value)
        Indicates the css class that will be applied to the not-selected element displayed.
        All the elements that are not marked as selected will use this css formatting when rendered.
        Parameters:
        value - String value of the CSS class to apply

      • setShortcutSelectedClass

        public void setShortcutSelectedClass​(java.lang.String value)
        Indicates the class that will be applied to the selected element displayed.
        The element marked as selected in the collection of shortcuts to render will use this css formatting. For marking an element as selected, its definition on the ShortcutList will have to include it, or if the selected attribute indicates which one it is.
        Parameters:
        value - String value of the CSS class to apply to the selected shortcut.

      • setType

        public void setType​(java.lang.String value)
        Indicates the type or name of shortcut list to display.
        Usage:
        In the out-of-the-box application samples of shortcut lists that can be rendered using these custom tags include toolbar and help.
        Parameters:
        value - String value of the type of shortcut list to display

      • setUcase

        public void setUcase​(boolean value)
        Indicates the upper case property, for displaying the options all in upper case or as defined in the list.
        Usage:
        If setting this property to true, the elements of the shortcut list to be displayed will be rendered all in upper case. By specifying false as value, or no attribute value defined, the name of the elements will be displayed as specified on the list.
        Parameters:
        value - boolean value defining the upper case flag

      • setSelected

        public void setSelected​(java.lang.String value)
        Indicates which element of the shorcut list shall be marked as selected.
        Usage:
        The element of the list to be marked as selected can be defined with this attribute, by setting as value the identifier (name) of it.
        Parameters:
        value - String value with the name of the shortcut to be marked as selected.