Package com.microstrategy.web.app.taglibs

Class EventTag

  • 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
    Direct Known Subclasses:
    FormEventTag, UrlEventTag
    public abstract class EventTag
extends AbstractBodyTag
    This class can be used as base for extending tags that render HTML associated with submitting an event, for example, forms and anchors. It has the EventArgumentTag custom tag as its child. An usage scenario might be defined as: 
     <web:urlEvent eventID="com.microstrategy.web.app.beans.EnumServletEvents.WebEventOpenPreferences">
   <web:eventArgument name="com.microstrategy.web.app.beans.EnumServletEvents.WebEventArgumentPreferenceGroup" value="general"/>
   <web:descriptor key="mstrWeb.295" desc="General"  >
 </web:urlEvent>
    The custom tag defined above is the UrlEventTag, which extends this abstract class. The event defined is for opening the Preferences page, having the group General shown. The text to be associated with this link ("General") is specified as part of the custom tag body.
    Note that not all the properties specified for this generic event tag might apply to all its children.
    Since:
    MicroStrategy Web 7.3.1 or earlier
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected EventTagHelper _helper  

      • 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
      EventTag()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AbstractBodyTagHelper getHelper()
      Gets the helper object associated with this tag instance
      void setBaseBean​(java.lang.String value)
      To be used together with the eventID attribute, it indicates which bean from the page shall be used as base for generating the event to be displayed by this tag.
      void setCssClass​(java.lang.String value)
      Indicates the name of the css class to be used when rendering the HTML content to be generated by this tag.
      void setEnabledCssClass​(java.lang.String value)
      Indicates the css style to be used for events whose links will be enabled.
      void setEnableEvent​(java.lang.String value)
      Indicates which feature condition could also be checked when trying to determine if the event will be enabled or not.
      void setEventID​(java.lang.String value)
      Indicates the ID of the event that will be used for generating this tag (form, link, etc).
      void setExtraURL​(java.lang.String value)
      Indicates any other extra attributes to be included on the HTML tag to render for this event tag.
      void setIncludeState​(boolean value)
      Indicates if the URL information to generate for this event will include the state of the beans on the page or not.
      void setLinkAttributes​(java.lang.String value)
      Sets the value assigned to the linkAttributes attribute of the custom tag instance that uses this helper
      void setRel​(java.lang.String value)
      Indicates the relationship type for links using this custom tag.
      void setStateLevel​(int value)
      To be used together with the includeState attribute value, it indicates the level of information to be added from each one of the beans defined on the page, to the resulting URL information to use for this event.
      void setTarget​(java.lang.String value)
      Indicates the target to use for the event to handle on this custom tag.
      void setTitleID​(java.lang.String value)
      set the value assigned to titleID to be used in tag's attribute TITLE.

      • 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

      • EventTag

        public EventTag()

    • Method Detail

      • setCssClass

        public void setCssClass​(java.lang.String value)
        Indicates the name of the css class to be used when rendering the HTML content to be generated by this tag.
        Usage:
        The css style specified here will be used as formatting for the link (if any) to be generated by the event tag. If the information to display is enabled (based on the enableEvent attribute value) then the enabledCssClass value will be used instead if available.
        Parameters:
        value - String value with the name of the css class to use.

      • setEventID

        public void setEventID​(java.lang.String value)
        Indicates the ID of the event that will be used for generating this tag (form, link, etc).
        The event defined here should be a valid one, otherwise it will not have an effect on the resulting HTML to be shown to the user.
        Parameters:
        value - String value with the ID of the event to use for this tag.

      • setTarget

        public void setTarget​(java.lang.String value)
        Indicates the target to use for the event to handle on this custom tag.
        Usage:
        The value assigned to this attribute shall be used as TARGET value on the HTML tag to create with the given information (for example: <FORM TARGET="xxx" ACTION=... > or <A TARGET="xxx" HREF=... >
        Parameters:
        value - String value with the target to assign to the resulting HTML tag.

      • setRel

        public void setRel​(java.lang.String value)
        Indicates the relationship type for links using this custom tag.
        Usage:
        The value assigned to this attribute shall be used as REL value on the HTML tag to create with the given information (for example: <A TARGET="xxx" REL="XXX" HREF=... >
        Parameters:
        value - String value with the rel to assign to the resulting HTML tag.

      • setIncludeState

        public void setIncludeState​(boolean value)
        Indicates if the URL information to generate for this event will include the state of the beans on the page or not.
        Parameters:
        value - boolean value indicating if the state of the beans should be included on the URL information to generate.

      • setStateLevel

        public void setStateLevel​(int value)
        To be used together with the includeState attribute value, it indicates the level of information to be added from each one of the beans defined on the page, to the resulting URL information to use for this event.
        Usage:
        The value to specify here can be any of the values defined on the EnumWebPersistableState enumeration.
        Parameters:
        value - int value indicating the level of information to use when saving bean states.

      • setEnableEvent

        public void setEnableEvent​(java.lang.String value)
        Indicates which feature condition could also be checked when trying to determine if the event will be enabled or not.
        Usage:
        The string given as attribute value has to belong to the list of possible features to check for, defined in enumerations like EnumAppWebFeatures. The condition defined here will be combined together with the boolean value generated by the feature attribute value specified.
        Parameters:
        value - String with the feature name to check for.

      • setEnabledCssClass

        public void setEnabledCssClass​(java.lang.String value)
        Indicates the css style to be used for events whose links will be enabled.
        Usage:
        If enableEvent attribute is missing, this value will be used as regular cssClass for the element (since it's always enabled). If the enabledCssClass and the enableEvent are missing but the cssClass attribute is specified, it will then be used for all enabled links.
        Parameters:
        value - String value with the name of the css class to use.

      • setExtraURL

        public void setExtraURL​(java.lang.String value)
        Indicates any other extra attributes to be included on the HTML tag to render for this event tag.
        Usage:
        It can be used for including JavaScript calls triggered by different events, etc.
        Parameters:
        value - String value with the text to include as part of the resulting HTML tag to render.

      • setBaseBean

        public void setBaseBean​(java.lang.String value)
        To be used together with the eventID attribute, it indicates which bean from the page shall be used as base for generating the event to be displayed by this tag.
        Parameters:
        value - String value with the name of the bean to use for generating the event to render.

      • setLinkAttributes

        public void setLinkAttributes​(java.lang.String value)
        Sets the value assigned to the linkAttributes attribute of the custom tag instance that uses this helper
        Parameters:
        value - String value that indicates the extra attributes to be added to the anchor tag.
        Since:
        MicroStrategy Web 8.0.0