public interface

RWSectionDef

implements RWUnitDef
com.microstrategy.web.objects.rw.RWSectionDef
Known Indirect Subclasses

Class Overview

Represents section definition

Summary

Public Methods
abstract RWUnitDef addChild(int unitType, String unitKey)
Adds the specified child unit
abstract RWUnitDef addChild(int unitType)
Adds the specified child unit
abstract RWUnitDef addChild(int unitType, String unitKey, String beforeKey)
Adds the specified child unit
abstract RWControlDef addControl(String key, int type, EnumWebControlSubType subType, String ctlNodeKey)
abstract RWControlDef addControl(String key, int type, String ctlNodeKey)
abstract RWControlDef addControl(String key, int type)
Adds control unit to this section
abstract RWUnitDef getChild(int index)
Returns i-th child unit definition.
abstract RWUnitDef getChildByKey(String key)
Returns child definition with specified key.
abstract int getChildCount()
Return a number of children
abstract RWFieldGroupDef getFieldGroup()
abstract RWGroupBy getGroupBy()
Returns a group by object associated with this section
abstract int getGroupByLevel()
Returns a group by level of the section
abstract int indexOf(RWUnitDef child)
Returns an index of specified child
abstract boolean isHorizontal()
Return true or false depending on whether the section is horizontal or vertical
abstract RWUnitDef removeChildByKey(String key)
Removes child unit with specified key
abstract void setHorizontal(boolean isHorizontal)
Sets the orientation of the section to be either horizontal (true) or vertical false.
abstract void sortChildren(Comparator comparator)
Sorts children based on the specified comparator
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebThresholdsContainer
From interface com.microstrategy.web.objects.rw.RWUnitDef

Public Methods

public abstract RWUnitDef addChild (int unitType, String unitKey)

Adds the specified child unit

Parameters
unitType unit type
unitKey unit key
Returns
  • added unit

public abstract RWUnitDef addChild (int unitType)

Adds the specified child unit

Parameters
unitType unit type
Returns
  • the specified child unit

public abstract RWUnitDef addChild (int unitType, String unitKey, String beforeKey)

Adds the specified child unit

Parameters
unitType unit type
unitKey unit key
beforeKey the existing unit key before which to insert a new one
Returns
  • added unit

public abstract RWControlDef addControl (String key, int type, EnumWebControlSubType subType, String ctlNodeKey)

public abstract RWControlDef addControl (String key, int type, String ctlNodeKey)

public abstract RWControlDef addControl (String key, int type)

Adds control unit to this section

Parameters
key control unit key
type control type
Returns
  • new control unit

public abstract RWUnitDef getChild (int index)

Returns i-th child unit definition.

Returns
  • i-th child unit definition

public abstract RWUnitDef getChildByKey (String key)

Returns child definition with specified key. (This method is not used in prototype).

Returns
  • child definition with specified key.

public abstract int getChildCount ()

Return a number of children

Returns
  • a number of children

public abstract RWFieldGroupDef getFieldGroup ()

Returns
  • the filedGroup element in this section

public abstract RWGroupBy getGroupBy ()

Returns a group by object associated with this section

Returns
  • a group by object associated with this section

public abstract int getGroupByLevel ()

Returns a group by level of the section

Returns
  • a group by level of the section

public abstract int indexOf (RWUnitDef child)

Returns an index of specified child

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

public abstract boolean isHorizontal ()

Return true or false depending on whether the section is horizontal or vertical

Returns
  • true is the section is oriented horizontally
    false if the section is oriented vertically

public abstract RWUnitDef removeChildByKey (String key)

Removes child unit with specified key

Returns
  • child unit with specified key

public abstract void setHorizontal (boolean isHorizontal)

Sets the orientation of the section to be either horizontal (true) or vertical false. If the orientation is horizontal, this call will also set the height of all children subsections to be the same as the first subsection.

Parameters
isHorizontal boolean to indicate whether horizontal or vertical
Throws
WebObjectsException

public abstract void sortChildren (Comparator comparator)

Sorts children based on the specified comparator

Parameters
comparator Comparator