Package com.microstrategy.web.objects.rw

Interface RWSection

  • All Superinterfaces:
    RWUnit
    public interface RWSection
extends RWUnit
    Represents data section
    Since:
    MicroStrategy Web 8.0.0

    • Method Detail

      • getChildCount

        int getChildCount()
        Returns number of children
        Returns:
        number of children

      • setSkippedChildrenOnce

        void setSkippedChildrenOnce​(boolean skipped)
        Set an indicator for the section to skip iteration to its children once.
        Parameters:
        skipped -
        Since:
        MicroStrategy Web 8.1.0

      • getChild

        RWUnit getChild​(int index)
        Returns i-th child unit definition.
        Parameters:
        index -
        Returns:
        i-th child unit definition.

      • indexOf

        int indexOf​(RWUnit child)
        Returns an index of specified child
        Parameters:
        child - a child unit
        Returns:
        an index of specified child

      • sortChildren

        void sortChildren​(java.util.Comparator comparator)
        Sorts children based on the specified comparator
        Parameters:
        comparator - a comparator used for sorting

      • getRoot

        RWSection getRoot()
        Returns data root section
        Returns:
        root section
        Since:
        MicroStrategy Web 8.1.0

      • isBeginOfHorizontalSections

        boolean isBeginOfHorizontalSections()
        Returns true if the section or subsection is the first horizontal section in a horizontal zone. For example, if a document has attribute A in the group by and is set to horizontal orientation, then this method returns true for the first A-Header section and the first subsection in this header section.
        Returns:
        boolean to indicate if the section is the first horizontal section
        Since:
        MicroStrategy Web 9.0.0

      • isEndOfHorizontalSections

        boolean isEndOfHorizontalSections()
        Returns true if the section or subsection is the last horizontal section in a horizontal zone. For example, if a document has attribute A in the group by and is set to horizontal orientation, then this method returns true for the last A-Footer section and the last subsection in this footer section.
        Returns:
        boolean to indicate if the section is the last horizontal section
        Since:
        MicroStrategy Web 9.0.0

      • getGroupByElements

        SimpleList getGroupByElements()
        Since:
        MicroStrategy Web 9.0.0