Package com.microstrategy.web.app.taglibs

Class PanelTagHelper

    • Constructor Summary

      Constructors 
      Constructor Description
      PanelTagHelper()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void cleanState()
      Resets the state of the tag library, by cleaning the values of the properties initialized for this tag.
      java.lang.String getContent()
      Processes the contents and attributes of the tag for getting it rendered.
      MarkupOutput getContentHead()
      Obtains the contents to render before the tag's body.
      MarkupOutput getContentTail()
      Obtains the contents to render after the tag's body.
      boolean isTagVisible()
      Indicates if the tag is visible or not.
      void setBodyClass​(java.lang.String value)
      Defines the class of the panel's body.
      void setCloseAttributes​(java.lang.String value)
      Defines the different attributes for the title when the panel is closed, determined by the children tag Panel_CloseInfoTag.
      void setCloseImg​(java.lang.String value)
      Defines the image of the panel's title when the panel is closed, determined by the children tag Panel_CloseInfoTag.
      void setCloseInfo​(java.lang.String img, java.lang.String width, java.lang.String height, java.lang.String align, java.lang.String imgClass, java.lang.String closeTooltip)
      Utility method that allows the Panel_CloseInfoTag child tag set the properties defined to use when the panel is shown opened, so this information is for having it closed.
      void setCloseToolTip​(java.lang.String value)
      Defines the tooltip of the panel's title when the panel is closed, determined by the children tag Panel_CloseInfoTag.
      void setColWidth​(java.lang.String value)
      Sets the width of the column to be displayed next to the panel's contents
      void setHalign​(java.lang.String value)
      Sets the value assigned to the hAlign attribute of the custom tag instance that uses this helper
      void setLanguage​(int value)
      Sets the value assigned to the language attribute of the custom tag instance that uses this helper
      void setName​(java.lang.String value)
      Sets the value assigned to the name attribute of the custom tag instance that uses this helper
      void setOpenAttributes​(java.lang.String value)
      Defines the different attributes for the title when the panel is opened, determined by the children tag Panel_OpenInfo.
      void setOpenImg​(java.lang.String value)
      Defines the image of the panel's title when the panel is opened, determined by the children tag Panel_OpenInfo.
      void setOpenInfo​(java.lang.String img, java.lang.String width, java.lang.String height, java.lang.String align, java.lang.String imgClass, java.lang.String openTooltip)
      Utility method that allows the Panel_OpenInfo child tag set the properties defined to use when the panel is closed, so this information is for having it opened.
      void setOpenToolTip​(java.lang.String value)
      Defines the tooltip of the panel's title when the panel is opened, determined by the children tag Panel_OpenInfo.
      void setPanelContent​(java.lang.String value)
      Defines the string that contains the HTML code to render as panel content.
      void setPosition​(java.lang.String value)
      Sets the value assigned to the position attribute of the custom tag instance that uses this helper
      void setTitleClass​(java.lang.String value)
      Defines the class of the panel's title.
      void setTitleText​(java.lang.String value)
      Defines the text of the panel's title.
      void setUseImage​(boolean value)
      Sets the value assigned to the useImage attribute of the custom tag instance that uses this helper
      void setValign​(java.lang.String value)
      Sets the value assigned to the vAlign attribute of the custom tag instance that uses this helper
      void setWidth​(java.lang.String value)
      Sets the value assigned to the width attribute of the custom tag instance that uses this helper
      boolean shallRepeatTag()
      Indicates if the content of the tag should be analyzed and displayed again or not.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PanelTagHelper

        public PanelTagHelper()

    • Method Detail

      • cleanState

        public void cleanState()
        Resets the state of the tag library, by cleaning the values of the properties initialized for this tag.
        Overrides:
        cleanState in class MstrPageTagHelper

      • getContent

        public java.lang.String getContent()
        Processes the contents and attributes of the tag for getting it rendered.

      • isTagVisible

        public boolean isTagVisible()
        Indicates if the tag is visible or not.
        Specified by:
        isTagVisible in class AbstractBodyTagHelper
        Returns:
        a boolean value indicating if the tag is visible or not.

      • shallRepeatTag

        public boolean shallRepeatTag()
        Indicates if the content of the tag should be analyzed and displayed again or not.
        Specified by:
        shallRepeatTag in class AbstractBodyTagHelper
        Returns:
        a boolean value indicating if the tag contents should be analyzed again or not.

      • getContentHead

        public MarkupOutput getContentHead()
                            throws java.io.IOException
        Obtains the contents to render before the tag's body.
        Specified by:
        getContentHead in class AbstractBodyTagHelper
        Returns:
        a MarkupOutput instance initialized with the contents to display
        Throws:
        java.io.IOException - if an error happens while getting the contents to render.

      • getContentTail

        public MarkupOutput getContentTail()
                            throws java.io.IOException
        Obtains the contents to render after the tag's body.
        Specified by:
        getContentTail in class AbstractBodyTagHelper
        Returns:
        a MarkupOutput instance initialized with the contents to display
        Throws:
        java.io.IOException - if an error happens while getting the contents to render.

      • setWidth

        public void setWidth​(java.lang.String value)
        Sets the value assigned to the width attribute of the custom tag instance that uses this helper
        Parameters:
        value - String value of the width

      • setName

        public void setName​(java.lang.String value)
        Sets the value assigned to the name attribute of the custom tag instance that uses this helper
        Parameters:
        value - String name value

      • setPosition

        public void setPosition​(java.lang.String value)
        Sets the value assigned to the position attribute of the custom tag instance that uses this helper
        Parameters:
        value - String position value

      • setHalign

        public void setHalign​(java.lang.String value)
        Sets the value assigned to the hAlign attribute of the custom tag instance that uses this helper
        Parameters:
        value - String value of horizontal alignment

      • setValign

        public void setValign​(java.lang.String value)
        Sets the value assigned to the vAlign attribute of the custom tag instance that uses this helper
        Parameters:
        value - String value of vertical alignment

      • setUseImage

        public void setUseImage​(boolean value)
        Sets the value assigned to the useImage attribute of the custom tag instance that uses this helper
        Parameters:
        value - boolean value indicating if image should be used on the panel or not

      • setLanguage

        public void setLanguage​(int value)
        Sets the value assigned to the language attribute of the custom tag instance that uses this helper
        Parameters:
        value - int value for the language

      • setTitleClass

        public void setTitleClass​(java.lang.String value)
        Defines the class of the panel's title. The class to use is determined by the children tags Panel_CloseInfoTag or Panel_OpenInfo depending on the state of the panel (opened or closed).
        Parameters:
        value - String value of the class

      • setBodyClass

        public void setBodyClass​(java.lang.String value)
        Defines the class of the panel's body. The class to use is determined by the children tags Panel_CloseInfoTag or Panel_OpenInfo depending on the state of the panel (opened or closed).
        Parameters:
        value - String value of the class

      • setTitleText

        public void setTitleText​(java.lang.String value)
        Defines the text of the panel's title. The text to use is determined by the children tags Panel_CloseInfoTag or Panel_OpenInfo depending on the state of the panel (opened or closed).
        Parameters:
        value - String value with the text for the title

      • setOpenToolTip

        public void setOpenToolTip​(java.lang.String value)
        Defines the tooltip of the panel's title when the panel is opened, determined by the children tag Panel_OpenInfo.
        Parameters:
        value - String value with the text for the tooltip

      • setCloseToolTip

        public void setCloseToolTip​(java.lang.String value)
        Defines the tooltip of the panel's title when the panel is closed, determined by the children tag Panel_CloseInfoTag.
        Parameters:
        value - String value with the text for the tooltip

      • setOpenImg

        public void setOpenImg​(java.lang.String value)
        Defines the image of the panel's title when the panel is opened, determined by the children tag Panel_OpenInfo.
        Parameters:
        value - String value with the name of the image

      • setOpenAttributes

        public void setOpenAttributes​(java.lang.String value)
        Defines the different attributes for the title when the panel is opened, determined by the children tag Panel_OpenInfo.
        Parameters:
        value - String value with the value of the attributes to use

      • setCloseImg

        public void setCloseImg​(java.lang.String value)
        Defines the image of the panel's title when the panel is closed, determined by the children tag Panel_CloseInfoTag.
        Parameters:
        value - String value with the name of the image

      • setCloseAttributes

        public void setCloseAttributes​(java.lang.String value)
        Defines the different attributes for the title when the panel is closed, determined by the children tag Panel_CloseInfoTag.
        Parameters:
        value - String value with the value of the attributes to use

      • setPanelContent

        public void setPanelContent​(java.lang.String value)
        Defines the string that contains the HTML code to render as panel content.
        Parameters:
        value - String value that includes the HTML/DHTML code to display as the panel's contents

      • setColWidth

        public void setColWidth​(java.lang.String value)
        Sets the width of the column to be displayed next to the panel's contents
        Parameters:
        value - String value of the column's width

      • setCloseInfo

        public void setCloseInfo​(java.lang.String img,
                         java.lang.String width,
                         java.lang.String height,
                         java.lang.String align,
                         java.lang.String imgClass,
                         java.lang.String closeTooltip)
        Utility method that allows the Panel_CloseInfoTag child tag set the properties defined to use when the panel is shown opened, so this information is for having it closed.
        Parameters:
        img - Image to display
        width - Width of the column next to the panel's content, to hold the image to display
        height - Height of the image to show next to the panel's content
        align - Alignment for the image
        imgClass - Class for the image
        closeTooltip - Tooltip to display for the image

      • setOpenInfo

        public void setOpenInfo​(java.lang.String img,
                        java.lang.String width,
                        java.lang.String height,
                        java.lang.String align,
                        java.lang.String imgClass,
                        java.lang.String openTooltip)
        Utility method that allows the Panel_OpenInfo child tag set the properties defined to use when the panel is closed, so this information is for having it opened.
        Parameters:
        img - Image to display
        width - Width of the column next to the panel's content, to hold the image to display
        height - Height of the image to show next to the panel's content
        align - Alignment for the image
        imgClass - Class for the image
        openTooltip - Tooltip to display for the image