Package com.microstrategy.web.app.transforms

Class SortEditorTransform

    • Constructor Detail

      • SortEditorTransform

        public SortEditorTransform()
        Since:
        MicroStrategy Web 9.0.0

    • Method Detail

      • 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

      • getIsGridSelected

        public boolean getIsGridSelected()
        Indicates whether the sort editor is being used to sort a selected grid
        Returns:
        true if a grid has been selected by the user.

      • getHasGroupByUnits

        public boolean getHasGroupByUnits()
        Indicates whether the document has group by attributes.
        Returns:
        true if the are group by attributes in the document

      • renderSortByInfo

        public void renderSortByInfo​(MarkupOutput out)
        Renders the sort options for the selected grid and for the document attributes
        Parameters:
        out - MarkupOutput instance where to create the HTML output

      • 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

      • renderTemplateUnits

        public void renderTemplateUnits​(MarkupOutput out)
        The method renders a select box containing all the available template units and its forms in case a grid has been selected or the attributes of the default data set associated with a document.
        Parameters:
        out - MarkupOutput instance where to create the HTML output

      • renderAscendingRadioButton

        public void renderAscendingRadioButton​(MarkupOutput out)
        Renders a radio button to select the ascending order for sorting by template units/document attributes.
        Parameters:
        out - MarkupOutput instance where to create the HTML output

      • renderDescendingRadioButton

        public void renderDescendingRadioButton​(MarkupOutput out)
        Renders a radio button to select the descending order for sorting by template units/document attributes.
        Parameters:
        out - MarkupOutput instance where to create the HTML output

      • renderGroupByInfo

        public void renderGroupByInfo​(MarkupOutput out)
        Renders the Sort Group By section for Documents
        Parameters:
        out - MarkupOutput instance where to create the HTML output

      • renderGroupByAscendingRadioButton

        public void renderGroupByAscendingRadioButton​(MarkupOutput out,
                                              SortDefinition sortDef)
        Renders a radio button to select the ascending order for sorting group by attributes.
        Parameters:
        out - MarkupOutput instance where to create the HTML output
        sortDef - SortDefinition instance containing the sort information associated with a group by attribute

      • renderGroupByDescendingRadioButton

        public void renderGroupByDescendingRadioButton​(MarkupOutput out,
                                               SortDefinition sortDef)
        Renders a radio button to select the descending order for sorting group by attributes.
        Parameters:
        out - MarkupOutput instance where to create the HTML output
        sortDef - SortDefinition instance containing the sort information associated with a group by attribute

      • renderGroupByForms

        public void renderGroupByForms​(MarkupOutput out,
                               SortDefinition sortDef)
        The method renders a select box containing all the available forms to sort by associated with the group by information included in the sortDef parameter.
        Parameters:
        out - MarkupOutput instance where to create the HTML output
        sortDef - SortDefinition instance containing the sort information associated with a group by attribute

      • renderRowTabLink

        public void renderRowTabLink​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0

      • renderColTabLink

        public void renderColTabLink​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0

      • renderCurrentTabContent

        public void renderCurrentTabContent​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0

      • getSortProcessEvent

        protected WebEvent getSortProcessEvent()
        Returns:
        an intance of the Sort Editor Process event the editor uses

      • renderSortNumber

        public void renderSortNumber​(MarkupOutput out,
                             java.lang.Integer value)
        Since:
        MicroStrategy Web 9.0.0

      • numberOfSortKeys

        public java.util.ArrayList<java.lang.Integer> numberOfSortKeys()
        Returns a list of integers until the value of the set preference.
        Returns:
        list of integers
        Since:
        MicroStrategy Web 9.0.0