public interface

RWSection

implements RWUnit
com.microstrategy.web.objects.rw.RWSection

Class Overview

Represents data section

Summary

Public Methods
abstract RWUnit getChild(int index)
Returns i-th child unit definition.
abstract int getChildCount()
Returns number of children
abstract SimpleList getGroupByElements()
abstract RWSection getRoot()
Returns data root section
abstract int indexOf(RWUnit child)
Returns an index of specified child
abstract boolean isBeginOfHorizontalSections()
Returns true if the section or subsection is the first horizontal section in a horizontal zone.
abstract boolean isEndOfHorizontalSections()
Returns true if the section or subsection is the last horizontal section in a horizontal zone.
abstract void setSkippedChildrenOnce(boolean skipped)
Set an indicator for the section to skip iteration to its children once.
abstract void sortChildren(Comparator comparator)
Sorts children based on the specified comparator
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.rw.RWUnit

Public Methods

public abstract RWUnit getChild (int index)

Returns i-th child unit definition.

Returns
  • i-th child unit definition.

public abstract int getChildCount ()

Returns number of children

Returns
  • number of children

public abstract SimpleList getGroupByElements ()

public abstract RWSection getRoot ()

Returns data root section

Returns
  • root section

public abstract int indexOf (RWUnit child)

Returns an index of specified child

Parameters
child a child unit
Returns
  • an index of specified child

public abstract 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

public abstract 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

public abstract void setSkippedChildrenOnce (boolean skipped)

Set an indicator for the section to skip iteration to its children once.

public abstract void sortChildren (Comparator comparator)

Sorts children based on the specified comparator

Parameters
comparator a comparator used for sorting