Package com.microstrategy.web.app.taglibs

Class Panel_PanelTag

  • 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 Panel_PanelTag
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

    • Constructor Summary

      Constructors 
      Constructor Description
      Panel_PanelTag()  

    • 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.
      AbstractBodyTagHelper getHelper()
      Gets the helper object associated with this tag instance
      void release()
      Utility method for cleaning up the properties on the custom tag instance.
      void setHalign​(java.lang.String value)
      Indicates the horizontal location (alignment) of the graphic that will be used for expanding/collapsing the panel.
      void setLanguage​(int value)
      Sets the language type to be used for creating the panel.
      void setName​(java.lang.String value)
      Indicates the name -unique identifier- of the panel to be displayed.
      void setPosition​(java.lang.String value)
      Indicates the position the panel will have when rendered.
      void setUseImage​(boolean value)
      Indicates if there's an image to display as part of the header, for the user to be able to click on it for opening or closing the panel.
      void setValign​(java.lang.String value)
      Indicates the vertical location (alignment) of the graphic that will be used for expanding/collapsing the panel.
      void setWidth​(java.lang.String value)
      Indicates the overall width of the panel to be displayed.

      • 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

      • Panel_PanelTag

        public Panel_PanelTag()

    • 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 AbstractBodyTag

      • 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_TAG 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

      • setWidth

        public void setWidth​(java.lang.String value)
        Indicates the overall width of the panel to be displayed.
        Usage:
        If the panel is to have a specific width, it can be defined here. If none, then the table that will hold the contents of the panel will default to be 100% according to its context.
        Parameters:
        value - String value of the width

      • setName

        public void setName​(java.lang.String value)
        Indicates the name -unique identifier- of the panel to be displayed.
        Usage:
        The panes need to have a name assigned if they are going to be enabled for DHTML, JavaScript and cookie environments. If no name is assigned, none will be set to them by default and it will make the panel not functional in the environments mentioned before. Since all the panels are designed to remember their last state with cookies (or other structures if cookies not enabled) then it is a requirement to have them defined with a name.
        Parameters:
        value - String name value to assign to the panel.

      • setPosition

        public void setPosition​(java.lang.String value)
        Indicates the position the panel will have when rendered.
        The panel to display could be specified to collapse and expand vertically or horizontally, this attribute allows the users to define its behavior.
        Usage:
        Possible values include vertical for it to expand and collapse vertically (up and down), or horizontal (left and right). If not specified, the default value is vertical.
        Parameters:
        value - String value with the position to specify.

      • setHalign

        public void setHalign​(java.lang.String value)
        Indicates the horizontal location (alignment) of the graphic that will be used for expanding/collapsing the panel.
        The panel can have an image associated to it, where the user will click for having the panel opened or closed. The use of the image is optional,
        Usage
        Possible values include right if the image for representing the panel open or closed is to be placed on the right side, or left. If not specified, it will default to left.
        Parameters:
        value - String value of horizontal alignment to use.

      • setValign

        public void setValign​(java.lang.String value)
        Indicates the vertical location (alignment) of the graphic that will be used for expanding/collapsing the panel.
        The panel can have an image related to it, where the user will click for having the panel opened or closed. The use of this image is optional.
        Usage:
        Possible values include top if the title and image for representing the panel open or closed is to be placed on top, or bottom. If not specified, it will default to top.
        Parameters:
        value - String value of vertical alignment to use.

      • setUseImage

        public void setUseImage​(boolean value)
        Indicates if there's an image to display as part of the header, for the user to be able to click on it for opening or closing the panel.
        A panel might not have an image if it's to be displayed based on another panel's state, so the user does not quite control when it should be opened or not. Usage:
        The possible values for this attribute include true and false. By default it is false.
        Parameters:
        value - boolean indicating if the panel will use an image or not.

      • setLanguage

        public void setLanguage​(int value)
        Sets the language type to be used for creating the panel.
        This attribute indicates if the panel will work in HTML or DHTML mode. Even that this attribute might specify the panel works on DHTML mode, it might be rendered as HTML if the user's view preference indicates it is on HTML or in Accessibility Mode.
        Usage:
        Possible values include 0 for using HTML mode and 1 for generating DHTML code.
        Parameters:
        value - int value for the language mode to use when rendering the panel.