Package com.microstrategy.web.app.transforms

Class SubtotalsEditorTransform

    • Field Detail

      • propertiesFile

        public FormalParameter propertiesFile
        Indicates name of the properties file that defines the supported subtotals.

    • Constructor Detail

      • SubtotalsEditorTransform

        public SubtotalsEditorTransform()
        Default no-args constructor, initialize formal parameters.

    • Method Detail

      • initializeFormalParameters

        public void initializeFormalParameters()
        Initialize the css classes to be used by this transform.

      • getDescription

        public java.lang.String getDescription()
        Returns the textual description of the transform
        Specified by:
        getDescription in interface Transform
        Returns:
        the description of the transform

      • getSubtotalsDefinitions_OldIServer

        public java.util.ArrayList getSubtotalsDefinitions_OldIServer()
        Returns:
        an ArrayList of SubtotalDefinition objects for all the subtotals supported by the editor
        Since:
        MicroStrategy Web 9.0.0

      • getSubtotalsDefinitions

        public java.util.ArrayList getSubtotalsDefinitions()
        Returns:
        an ArrayList of SubtotalDefinition objects for all the subtotals supported by the editor

      • renderContentsBody

        public void renderContentsBody​(MarkupOutput out)
        Generates the graphical output for the Projects Bean
        Parameters:
        out - MarkupOutput instance where to create the HTML output
        Since:
        MicroStrategy Web 9.0.0

      • renderHiddenInputs

        public void renderHiddenInputs​(MarkupOutput out)
        Renders the list of hidden inputs required by the editor
        Parameters:
        out - MarkupOutput instance where to create the HTML output

      • renderSubtotalName

        public void renderSubtotalName​(MarkupOutput out,
                               SubtotalDefinition subtotalDef)
        Renders the description of the subtotal.
        Parameters:
        out - MarkupOutput instance where to create the HTML output
        subtotalDef - SubtotalDefinition object containing the definition of the subtotal

      • renderSubtotalCheckbox

        public void renderSubtotalCheckbox​(MarkupOutput out,
                                   SubtotalDefinition subtotalDef)
        Renders the Subtotals Checkbox of the current subtotal
        Parameters:
        out - MarkupOutput instance where to create the HTML output
        subtotalDef - SubtotalDefinition object containing the definition of the subtotal

      • renderSubtotalCheckbox_OldIServer

        public void renderSubtotalCheckbox_OldIServer​(MarkupOutput out,
                                              SubtotalDefinition subtotalDef)
        Renders the Subtotals Checkbox of the current subtotal if it's old iserver
        Parameters:
        out - MarkupOutput instance where to create the HTML output
        subtotalDef - SubtotalDefinition object containing the definition of the subtotal
        Since:
        MicroStrategy Web 9.0.0

      • renderTotalCheckbox

        public void renderTotalCheckbox​(MarkupOutput out,
                                SubtotalDefinition subtotalDef)
        Renders the Grand Total Checkbox of the current subtotal
        Parameters:
        out - MarkupOutput instance where to create the HTML output
        subtotalDef - SubtotalDefinition object containing the definition of the subtotal

      • renderTotalCheckbox_OldIServer

        public void renderTotalCheckbox_OldIServer​(MarkupOutput out,
                                           SubtotalDefinition subtotalDef)
        Renders the Grand Total Checkbox of the current subtotal if it's old iserver
        Parameters:
        out - MarkupOutput instance where to create the HTML output
        subtotalDef - SubtotalDefinition object containing the definition of the subtotal
        Since:
        MicroStrategy Web 9.0.0

      • renderCheckbox

        public void renderCheckbox​(MarkupOutput out,
                           SubtotalDefinition subtotalDef,
                           int subtotalType,
                           int subtotalStyle)
        Renders the checkbox for the subtotals events
        Parameters:
        out - MarkupOutput instance where to create the HTML output
        subtotalDef - SubtotalDefinition object containing the definition of the subtotal
        subtotalType - from EnumSubtotalsEditorEvents
        subtotalStyle - from EnumDSSXMLSubtotalStyle

      • getCheckboxTitle

        protected java.lang.String getCheckboxTitle​(SubtotalDefinition subtotalDef,
                                            int subtotalStyle)
        Since:
        MicroStrategy Web 8.0.1

      • getSubtotalsProcessEvent

        protected WebEvent getSubtotalsProcessEvent()
        Returns:
        an intance of the Subtotals Editor Process event the editor uses

      • getOnSubmitJS

        protected java.lang.String getOnSubmitJS()
        Description copied from class: AbstractEditorTransform
        Provides JS code to be executed on the "onsubmit" event of the HTML form.
        Used for customizations where an action is needed before the form is submitted.
        Note: this is only used when the editor uses an event and not JS on the OK/Apply buttons. For those cases use the "okJS" or "applyJS" formal parameters
        Overrides:
        getOnSubmitJS in class AbstractEditorTransform
        Returns:
        JS code to be executed on the "onsubmit" event of the HTML form.
        Since:
        MicroStrategy Web 8.1.2