Package com.microstrategy.web.app.taglibs

Class ShortcutPropertyTag

  • All Implemented Interfaces:
    java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
    public class ShortcutPropertyTag
extends javax.servlet.jsp.tagext.TagSupport
    Since:
    MicroStrategy Web 7.3.1 or earlier
    See Also:
    Serialized Form

    • Field Summary

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

        id, pageContext

      • 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 doStartTag()
      Processes the start tag for this instance.
      void release()
      Utility method for cleaning up the properties on the custom tag instance.
      void setName​(java.lang.String value)
      Indicates a unique identifier for the property to be added to the tags that include it on its definition.
      void setSelectedValue​(java.lang.String value)
      Indicates the property value to add when the shortcut element to render in that pass is marked as selected.
      void setValue​(java.lang.String value)
      Indicates the property value to add when the shortcut element to render in that pass is not marked as selected.

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

        doAfterBody, doEndTag, 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

    • Constructor Detail

      • ShortcutPropertyTag

        public ShortcutPropertyTag()

    • Method Detail

      • release

        public void release()
        Utility method for cleaning up the properties on the custom tag instance.
        Specified by:
        release in interface javax.servlet.jsp.tagext.Tag
        Overrides:
        release in class javax.servlet.jsp.tagext.TagSupport

      • doStartTag

        public int doStartTag()
               throws javax.servlet.jsp.JspException
        Processes 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 javax.servlet.jsp.tagext.TagSupport
        Returns:
        SKIP_BODY since it does not want to process or display it.
        Throws:
        javax.servlet.jsp.JspException - if an error is risen when displaying the custom tag contents

      • setName

        public void setName​(java.lang.String value)
        Indicates a unique identifier for the property to be added to the tags that include it on its definition.
        Usage:
        The same name specified in this custom tag as the name property needs to be added to each and every HTML tag inside the ShortcutOptionsTag tag that is required to have the special attributes added to it.
        Parameters:
        value - String value of the identifier for the property

      • setValue

        public void setValue​(java.lang.String value)
        Indicates the property value to add when the shortcut element to render in that pass is not marked as selected.
        Usage:
        An example value of this attribute could be CLASS=notSelectedClass
        Parameters:
        value - String value of the property to apply to not-selected shortcuts/options

      • setSelectedValue

        public void setSelectedValue​(java.lang.String value)
        Indicates the property value to add when the shortcut element to render in that pass is marked as selected.
        Usage:
        An example value of this attribute could be CLASS=selectedClass
        Parameters:
        value - String value of the property to apply to selected shortcuts/options