Package com.microstrategy.web.app.taglibs

Class DynTableTagHelper

    • 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 getBlankImg()
      Returns a 'gif' image and the path to use for rendering transparent images (if required)
      int getCols()
      Gets the value assigned to the cols attribute of the custom tag instance that uses this helper
      MarkupOutput getContentHead()
      Obtains the contents to render before the tag's body.
      MarkupOutput getContentTail()
      Obtains the contents to render after the tag's body.
      int getCurrentColumn()
      Gets the current column counter for the table, so the tag helper keeps track of how many cells have been rendered on the table before a change of row (new TR HTML tag) is required
      int getDist()
      Gets the width for the current column based on the number of columns that should be included in the HTML table.
      boolean isCellEnabled​(java.lang.String feature, java.lang.String enableFeature)
      Determines if the conditions requested via the feature and enableFeature attributes of the DynTableCellTag custom tag enables it to be displayed or not.
      boolean isTagVisible()
      Indicates if the tag is visible or not.
      void setCols​(int value)
      Sets the value assigned to the cols attribute of the custom tag instance that uses this helper
      void setCurrentColumn​(int value)
      Sets the current column counter for the table, so the tag helper keeps track of how many cells have been rendered on the table before a change of row (new <TR> HTML tag) is required
      void setPageComponent​(PageComponent mstrPage)
      Sets the PageComponent instance that will be used as base for the tag when generating the HTML to return to the user.
      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

      • DynTableTagHelper

        public DynTableTagHelper()

    • 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

      • setPageComponent

        public void setPageComponent​(PageComponent mstrPage)
        Sets the PageComponent instance that will be used as base for the tag when generating the HTML to return to the user. It will also initialize some properties based on information coming from the instance passed as parameter.
        Overrides:
        setPageComponent in class MstrPageTagHelper
        Parameters:
        mstrPage - PageComponent instance corresponding to the page to be shown to the user as a result of his request.

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

      • setCurrentColumn

        public void setCurrentColumn​(int value)
        Sets the current column counter for the table, so the tag helper keeps track of how many cells have been rendered on the table before a change of row (new <TR> HTML tag) is required
        Parameters:
        value - an int value indicating the new value of the counter.

      • getCurrentColumn

        public int getCurrentColumn()
        Gets the current column counter for the table, so the tag helper keeps track of how many cells have been rendered on the table before a change of row (new TR HTML tag) is required
        Returns:
        an int value indicating the new value of the counter.

      • isCellEnabled

        public boolean isCellEnabled​(java.lang.String feature,
                             java.lang.String enableFeature)
        Determines if the conditions requested via the feature and enableFeature attributes of the DynTableCellTag custom tag enables it to be displayed or not.
        Parameters:
        feature - String with the name of the feature to check for
        enableFeature - String with the name of the feature to check for enabling the cell
        Returns:
        a boolean value indicating if the cell with the conditions given should be displayed or not.

      • getDist

        public int getDist()
        Gets the width for the current column based on the number of columns that should be included in the HTML table.
        Returns:
        an int number indicating the width in percentage for the current column.

      • getBlankImg

        public java.lang.String getBlankImg()
        Returns a 'gif' image and the path to use for rendering transparent images (if required)
        Returns:
        a String with a image path and name representing a blank or transparent image.

      • setCols

        public void setCols​(int value)
        Sets the value assigned to the cols attribute of the custom tag instance that uses this helper
        Parameters:
        value - int value that defines the number of columns for the table to generate.

      • getCols

        public int getCols()
        Gets the value assigned to the cols attribute of the custom tag instance that uses this helper
        Returns:
        int value that defines the number of columns for the table to generate.