Package com.microstrategy.web.app.taglibs

Class DisplayBeanTag

  • All Implemented Interfaces:
    java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
    Direct Known Subclasses:
    ShowJsonBlocksTag
    public class DisplayBeanTag
extends AbstractNoBodyTag
    Custom Tag class to be used for displaying a bean with the requested transform style. If no style name is specified, then it will assume there's no other transform style to use but the default assigned during the bean's creation process.
    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

    • Constructor Summary

      Constructors 
      Constructor Description
      DisplayBeanTag()  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      AbstractNoBodyTagHelper getHelper()
      Method for retrieving the helper associated with the tag.
      void setBean​(java.lang.String value)
      Indicates the name of the bean that will be rendered in the final HTML content to be shown to the user.
      void setBeanName​(java.lang.String value)
      Deprecated.
      Use setBean(java.lang.String) Instead.
      void setGetTarget​(boolean value)
      Attribute to be used when a SubscriptionFolderBean is to be displayed.
      void setIgnoreCurrent​(boolean value)
      Attribute to be used when a PreferencesBean is to be displayed.
      void setRenderGroupList​(boolean value)
      Attribute to be used when a PreferencesBean is to be displayed.
      void setStatus​(int value)
      Indicates which is the status of the bean that will make it to be displayed.
      void setStyleName​(java.lang.String value)
      Indicates the transform style to apply to the bean for getting it rendered.

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

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

      • DisplayBeanTag

        public DisplayBeanTag()

    • Method Detail

      • setBean

        public void setBean​(java.lang.String value)
        Indicates the name of the bean that will be rendered in the final HTML content to be shown to the user.
        Parameters:
        value - String value with the name of the bean to search for.
        Since:
        MicroStrategy Web 8.0.0

      • setBeanName

        public void setBeanName​(java.lang.String value)
        Deprecated.
        Use setBean(java.lang.String) Instead.
        Indicates the name of the bean that will be rendered in the final HTML content to be shown to the user.
        Parameters:
        value - String value with the name of the bean to search for.

      • setStyleName

        public void setStyleName​(java.lang.String value)
        Indicates the transform style to apply to the bean for getting it rendered.
        Usage:
        The style name specified here has to be properly defined on the Style Catalog for it to be used. If this attribute is not included, then it will use the default style defined for the bean when it was created.
        Parameters:
        value - String value with the style to use for transforming the bean.

      • setGetTarget

        public void setGetTarget​(boolean value)
        Attribute to be used when a SubscriptionFolderBean is to be displayed. Indicates with this boolean attribute if the bean defined as target in the subscriptions bean should be the one to be transformed.
        Parameters:
        value - boolean indicating if the target of the subscriptions bean should be transformed or not.

      • setIgnoreCurrent

        public void setIgnoreCurrent​(boolean value)
        Attribute to be used when a PreferencesBean is to be displayed. Indicates with this boolean attribute if all the preference groups should be displayed as links (True), or if the selected group will be rendered with special formatting and not as a link (False).
        Parameters:
        value - boolean indicating if the current preference group should be ignored or not.

      • setStatus

        public void setStatus​(int value)
        Indicates which is the status of the bean that will make it to be displayed.
        Usage:
        The value specified for this attribute will have to be a valid int value from the EnumRequestStatus enumeration.
        Parameters:
        value - int value with the bean status to consider for rendering the bean.

      • setRenderGroupList

        public void setRenderGroupList​(boolean value)
        Attribute to be used when a PreferencesBean is to be displayed. Indicates with this boolean value if the group list of preferences should be displayed or not.
        Parameters:
        value - boolean indicating if the preference groups list should be displayed or not