Package com.microstrategy.web.app.taglibs

Class EventArgumentTag

  • All Implemented Interfaces:
    java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
    public class EventArgumentTag
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 setBaseEvent​(java.lang.String value)
      Indicates the full package, class name and constant that identifies the event which will be used as base for defining the main event argument value.
      void setName​(java.lang.String value)
      Indicates the full package, class name and constant that identifies the argument name to be added to the event.
      void setType​(java.lang.String value)
      Indicates if the event value will come from another event, in which the value to assign to the attribute will be eventParameter.
      void setValue​(java.lang.String value)
      Indicates the value that will be assigned to the argument specified.

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

        doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, 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

      • EventArgumentTag

        public EventArgumentTag()

    • Method Detail

      • 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

      • setValue

        public void setValue​(java.lang.String value)
        Indicates the value that will be assigned to the argument specified.
        Parameters:
        value - String with the value to assign to the event argument

      • setName

        public void setName​(java.lang.String value)
        Indicates the full package, class name and constant that identifies the argument name to be added to the event.
        Parameters:
        value - String with the identifier name of the event argument to add

      • setType

        public void setType​(java.lang.String value)
        Indicates if the event value will come from another event, in which the value to assign to the attribute will be eventParameter.
        Usage:
        Parameters:
        value - String indicating if the event will be an eventParameter or not

      • setBaseEvent

        public void setBaseEvent​(java.lang.String value)
        Indicates the full package, class name and constant that identifies the event which will be used as base for defining the main event argument value.
        Parameters:
        value - String with the identifier name of the base event that will define this event argument's value.