Package com.microstrategy.web.app.transforms

Class ReportToolbarTransform

  • All Implemented Interfaces:
    AppTransform, LayoutTransform, Transform
    public class ReportToolbarTransform
extends AbstractReportTransform
implements LayoutTransform
    This Transform generates the content of the report toolbar area. This Transform implements LayoutTransform, therefore it can be customized simply by changing its layout-xml.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • showStyleList

        protected FormalParameter showStyleList
        This is the flag used in the transform to specify whether to display auto styles list.
        Allowed Values: TRUE/FALSE.

      • imgGo

        protected FormalParameter imgGo
        This is the image name for go image used in the transform.
        Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • imgClose

        protected FormalParameter imgClose
        This is the image name for close image used in the transform.
        Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • imgCheckOff

        protected FormalParameter imgCheckOff
        This is the image name for check off image used in the transform.
        Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • imgCheckOn

        protected FormalParameter imgCheckOn
        This is the image name for check on image used in the transform.
        Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • gridIncrementalFetchStyleForRow

        protected FormalParameter gridIncrementalFetchStyleForRow
        This is the name of the style used to show the incremental fetch for row for grid reports.
        Allowed Values: any report style name from StyelCatalog.xml file.

      • graphIncrementalFetchStyleForRow

        protected FormalParameter graphIncrementalFetchStyleForRow
        This is the name of the style used to show the incremental fetch for row for grid graph reports.
        Allowed Values: any report style name from StyelCatalog.xml file.

      • gridGraphIncrementalFetchStyleForRow

        protected FormalParameter gridGraphIncrementalFetchStyleForRow
        This is the name of the style used to show the incremental fetch for row for grid graph reports.
        Allowed Values: any report style name from StyelCatalog.xml file.

      • showOutlineLevelButtons

        protected FormalParameter showOutlineLevelButtons
        It is used in the transform to specify whether to show the outline mode level buttons.
        Allowed Values: TRUE/FALSE.
        Since:
        MicroStrategy Web 8.0.0

      • outlineModeDefaultLevelMax

        protected FormalParameter outlineModeDefaultLevelMax
        If this value is set to true the default level at which any newly run report wil open for outline mode will be maximum expanded.
        If it is false, the default will be fully collapsed.
        This property will be used only if the report property denoting the outline mode level is not present.
        Allowed Values: String values.
        Since:
        MicroStrategy Web 8.0.0

      • uniqueReportId

        protected FormalParameter uniqueReportId
        This is the name of the report's associated bone.
        Allowed Values: String values.
        Since:
        MicroStrategy Web 8.0.0

      • gridAutoStyleBean

        protected FormalParameter gridAutoStyleBean
        This is the name of the grid autostyles bean.
        Allowed Values: String values.
        Since:
        MicroStrategy Web 8.0.0

    • Constructor Detail

      • ReportToolbarTransform

        public ReportToolbarTransform()
        default no-args constructor

    • Method Detail

      • isReportStylesAvailable

        public boolean isReportStylesAvailable()
        Since:
        MicroStrategy Web 8.0.0

      • isRowIncrementalFetchAvailable

        public boolean isRowIncrementalFetchAvailable()
        Returns:
        boolean true, if row incremental fetch information is available
        Since:
        MicroStrategy Web 8.0.0

      • isPivotButtonsAvailable

        public boolean isPivotButtonsAvailable()
        Returns:
        boolean true if the pivot buttons are available.
        Since:
        MicroStrategy Web 8.0.0

      • isSortButtonsAvailable

        public boolean isSortButtonsAvailable()
        Returns:
        boolean true if the sort buttons are available.
        Since:
        MicroStrategy Web 8.0.0

      • isOutlineModeAvailable

        public boolean isOutlineModeAvailable()
        Returns:
        boolean true if the outline mode is available (i.e. enabled and not in graph mode).
        Since:
        MicroStrategy Web 8.0.0

      • isRowCountAvailable

        public boolean isRowCountAvailable()
        Returns:
        boolean true if the row count is available for the report
        Since:
        MicroStrategy Web 8.0.0

      • isColumnCountAvailable

        public boolean isColumnCountAvailable()
        Returns:
        boolean true if the column count is available for the report
        Since:
        MicroStrategy Web 8.0.0

      • renderOutlineModeLevels

        public void renderOutlineModeLevels​(MarkupOutput out)
        Generates the buttons that changes the current outline mode level.
        Parameters:
        out - the MarkupOutput object
        Since:
        MicroStrategy Web 8.0.0

      • renderRowIncrementalFetch

        public void renderRowIncrementalFetch​(MarkupOutput mo)
        Since:
        MicroStrategy Web 8.0.0

      • renderReportStyles

        public void renderReportStyles​(MarkupOutput out)
        Generates the content for the report autostyles selection. Basically it simply it searches for the autostyle bean (as defined by the gridAutoStyleBean formal parameter) and if found, just calls transform() on it.
        Parameters:
        out - the MarkupOutput where the content is generated.
        Since:
        MicroStrategy Web 8.0.0

      • renderShowPivotButtons

        public void renderShowPivotButtons​(MarkupOutput out)
        Generates a link that will toggle the pivot buttons on/off
        Parameters:
        out - the MarkupOutput where the content is generated.
        Since:
        MicroStrategy Web 8.0.0

      • renderShowSortButtons

        public void renderShowSortButtons​(MarkupOutput out)
        Generates a link that toggles the sort buttons on/off
        Parameters:
        out - the MarkupOutput where the content is generated.
        Since:
        MicroStrategy Web 8.0.0

      • renderRowCount

        public void renderRowCount​(MarkupOutput out)
        Generates a message with the reports row count.
        Parameters:
        out - the MarkupOutput where the content is generated.
        Since:
        MicroStrategy Web 8.0.0

      • renderColumnCount

        public void renderColumnCount​(MarkupOutput out)
        Generates a message with the reports column count.
        Parameters:
        out - the MarkupOutput where the content is generated.
        Since:
        MicroStrategy Web 8.0.0

      • isGraphAvailable

        public boolean isGraphAvailable()
        Checks if the graph can be displayed with the available data.
        Since:
        MicroStrategy Web 9.0.0

      • getToggleSortButtonsEvent

        protected WebEvent getToggleSortButtonsEvent()
        Returns:
        the WebEvent used to toggle the sort buttons on/off
        Since:
        MicroStrategy Web 8.0.0

      • getTogglePivotButtonsEvent

        protected WebEvent getTogglePivotButtonsEvent()
        Returns:
        the WebEvent used to toggle the pivot buttons on/off
        Since:
        MicroStrategy Web 8.0.0

      • isShowingSortButtons

        protected boolean isShowingSortButtons()
        Returns:
        boolean true if sort buttons are currently on
        Since:
        MicroStrategy Web 8.0.0

      • isShowingPivotButtons

        protected boolean isShowingPivotButtons()
        Returns:
        boolean true if pivot buttons are currently on
        Since:
        MicroStrategy Web 8.0.0

      • getDescription

        public java.lang.String getDescription()
        Return description for this Transform
        Specified by:
        getDescription in interface Transform
        Returns:
        description for this Transform

      • getID

        public java.lang.String getID()
        Description copied from class: AbstractAppTransform
        Returns the unique name of the component to be used as the ID for its shell. This id is used for updating the page using the iFrame technology, and as the id for the corresponding bone (if any).
        Specified by:
        getID in interface Transform
        Overrides:
        getID in class AbstractAppTransform
        Returns:
        the component's unique id
        Since:
        MicroStrategy Web 9.0.0