Package com.microstrategy.web.app.transforms

Class ReportDesignModeTransformImpl

  • All Implemented Interfaces:
    AppTransform, ReportDataTransform, LayoutTransform, Transform
    public class ReportDesignModeTransformImpl
extends ReportGridTransformImpl
    The ReportDesignModeTransformImpl generates a grid visualization of the Report that allows to modify its definition.

    The main difference with the ReportGridTransformImpl is that this transform, instead of reading the report's data, it iterates through the Template definition; but it follows the same customization guidelines as its parent class.

    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • designModeDummyRowCount

        protected FormalParameter designModeDummyRowCount
        It is used in the transform to specify how many dummy rows are displayed in design mode.
        Allowed Values: positive integer values.

    • Constructor Detail

      • ReportDesignModeTransformImpl

        public ReportDesignModeTransformImpl()
        default no-args constructor

    • Method Detail

      • renderEmptyGrid

        public void renderEmptyGrid​(MarkupOutput out)
        It renders the output when the report grid is empty.
        For design mode, we always just call renderGrid
        Overrides:
        renderEmptyGrid in class ReportGridTransformImpl
        Parameters:
        out - MarkupOutput to generate the HTML.
        Since:
        MicroStrategy Web 8.0.0

      • renderGrid

        public void renderGrid​(MarkupOutput out)
        Generates the grid. In design mode, the grid needs to be enclosed in a form that allows to perform manipulations in HTML mode.
        Overrides:
        renderGrid in class ReportGridTransformImpl
        Parameters:
        out - MarkupOutput to generate the HTML.
        Since:
        MicroStrategy Web 8.0.0

      • renderGridHeaders

        public void renderGridHeaders​(MarkupOutput out)
        Generates the top part of the report, that is, the row titles, column titles and column headers.
        Overrides:
        renderGridHeaders in class ReportGridTransformImpl
        Parameters:
        out - MarkupOutput to generate the HTML.
        Since:
        MicroStrategy Web 8.0.0

      • renderGridData

        public void renderGridData​(MarkupOutput out)
        Generates the data content of the grid, this includes both Row headers and metric values.
        Overrides:
        renderGridData in class ReportGridTransformImpl
        Parameters:
        out - MarkupOutput to generate the HTML.
        Since:
        MicroStrategy Web 8.0.0

      • renderRowAxis

        public void renderRowAxis​(MarkupOutput out,
                          ReportBean rb,
                          WebAxis rowAxis)
        Display row axis for the template
        Parameters:
        out - MarkupOutput to generate the HTML.
        rb - ReportBean being transformed (ignored, always uses the bean passed to the initializeTransform method).
        rowAxis - the corresponding WebAxis

      • renderRowAxis

        public void renderRowAxis​(MarkupOutput out,
                          ReportBean rb,
                          WebAxis rowAxis,
                          boolean useEmptyRowTitle)
        Display row axis for the template
        Parameters:
        out - MarkupOutput to generate the HTML.
        rb - ReportBean being transformed (ignored, always uses the bean passed to the initializeTransform method).
        rowAxis - the corresponding WebAxis
        Since:
        MicroStrategy Web 9.0.0

      • isDesignMode

        protected boolean isDesignMode()
        This method always returns true, as this transform is used only in design mode.
        Overrides:
        isDesignMode in class ReportGridTransformImpl
        Returns:
        true
        Since:
        MicroStrategy Web 8.0.0

      • isDatamart

        public boolean isDatamart()
        This method always returns false, as this transform is used only in design mode.
        Overrides:
        isDatamart in class AbstractReportTransform
        Returns:
        false
        Since:
        MicroStrategy Web 8.0.0

      • isGridEmpty

        public boolean isGridEmpty()
        This method always returns true, whenever he template is empty
        Overrides:
        isGridEmpty in class AbstractReportDataTransform
        Returns:
        true if the template is empty.
        Since:
        MicroStrategy Web 8.0.0

      • getApplyChangesEvent

        protected WebEvent getApplyChangesEvent()
        Returns:
        apply changes event
        Since:
        MicroStrategy Web 8.0.0

      • getAttributesMainTable

        protected java.util.Map getAttributesMainTable()
        Returns:
        a map with border -> 0, cellspacing -> 0, cellpadding-> 0 and if its fit to contents width -> 100%
        Since:
        MicroStrategy Web 8.0.0

      • getAttributesGridTable

        protected java.util.Map getAttributesGridTable()
        Description copied from class: ReportGridTransformImpl
        Generates the list of attributes used by the grid's table. This method may be extended to include extra/custom attributes.
        Overrides:
        getAttributesGridTable in class ReportGridTransformImpl
        Returns:
        Map with the Attributes to use
        Since:
        MicroStrategy Web 8.0.0

      • getAttributesBoneDiv

        protected java.util.Map getAttributesBoneDiv()
        Description copied from class: ReportGridTransformImpl
        Generates the list of attributes used by a div surrounding the grid. This div includes the information used by grid's bone, such as scriptclass and subtype (sty).
        Overrides:
        getAttributesBoneDiv in class ReportGridTransformImpl
        Returns:
        Map with the Attributes to use
        Since:
        MicroStrategy Web 8.0.0

      • getAttributesForm

        protected java.util.Map getAttributesForm()
        Since:
        MicroStrategy Web 8.0.0