Package com.microstrategy.web.app.transforms

Class ReportPageByInfoTransform

  • All Implemented Interfaces:
    AppTransform, Transform
    public class ReportPageByInfoTransform
extends AbstractReportTransform
    Title: MSTR Web Transform Component: ReportPageByInfoTransform
    Description: Provides report bean a pageby transform. Used in ReportTransformPageBy and exporting feature.
    Copyright: Copyright (c) 2001
    Company: MicroStrategy
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • isPlainText

        protected FormalParameter isPlainText
        It is used in the transform to specify whether display in plain text or html.
        Allowed Values: TRUE/FALSE.

      • infoTitle

        protected FormalParameter infoTitle
        It is used in the transform to specify the title for this section.
        Allowed Values: any String

      • displayInSingleLine

        protected FormalParameter displayInSingleLine
        It is used in the transform to specify whether display all the pageby elements in one line or seperate lines.
        Allowed Values: TRUE/FALSE.

      • displayWhenNone

        protected FormalParameter displayWhenNone
        It is used in the transform to specify whether display when there is no pageby elements.
        Allowed Values: TRUE/FALSE.

    • Constructor Detail

      • ReportPageByInfoTransform

        public ReportPageByInfoTransform()
        default no-args constructor

    • Method Detail

      • isPlainText

        protected boolean isPlainText()
        whether display the information in plaintext, instead of HTML way.
        Returns:
        whether display the information in plaintext

      • displayInSingleLine

        protected boolean displayInSingleLine()
        whether display all the page by information in one line.
        If it returns false, each attribute will be displayed on seperate line.
        Returns:
        whether display all the page by information in one line

      • displayWhenNone

        protected boolean displayWhenNone()
        whether display some description (like "none") when there is no pageby attribute.
        Returns:
        display some description (like "none") when there is no pageby attribute

      • getDescription

        public java.lang.String getDescription()
        Return description for this Transform
        Returns:
        description for this Transform

      • renderShell

        public void renderShell​(MarkupOutput out)
        Description copied from class: AbstractAppTransform

        Generates the shell for this Transform.

        The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

        The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
        This method calls renderCssLink and checkStatus to generate the Transform's content.
        Overrides:
        renderShell in class AbstractAppTransform
        Parameters:
        out - output by this transform
        Since:
        MicroStrategy Web 8.0.0