Package com.microstrategy.web.objects.rw

Interface RWSectionDef

All Superinterfaces:

RWUnitDef, WebThresholdsContainer

All Known Subinterfaces:

RWLayoutSectionDef, RWPanelStackDef, RWSubsectionDef

public interface RWSectionDef
extends RWUnitDef

Represents section definition

Since:

MicroStrategy Web 8.0.0

Method Summary

Modifier and Type	Method	Description
RWUnitDef	addChild(int unitType)	Adds the specified child unit
RWUnitDef	addChild(int unitType, java.lang.String unitKey)	Adds the specified child unit
RWUnitDef	addChild(int unitType, java.lang.String unitKey, java.lang.String beforeKey)	Adds the specified child unit
RWControlDef	addControl(java.lang.String key, int type)	Adds control unit to this section
RWControlDef	addControl(java.lang.String key, int type, EnumWebControlSubType subType, java.lang.String ctlNodeKey)
RWControlDef	addControl(java.lang.String key, int type, java.lang.String ctlNodeKey)
RWUnitDef	getChild(int index)	Returns i-th child unit definition.
RWUnitDef	getChildByKey(java.lang.String key)	Returns child definition with specified key.
int	getChildCount()	Return a number of children
RWFieldGroupDef	getFieldGroup()
RWGroupBy	getGroupBy()	Returns a group by object associated with this section
int	getGroupByLevel()	Returns a group by level of the section
int	indexOf(RWUnitDef child)	Returns an index of specified child
boolean	isHorizontal()	Return true or false depending on whether the section is horizontal or vertical
RWUnitDef	removeChildByKey(java.lang.String key)	Removes child unit with specified key
void	setHorizontal(boolean isHorizontal)	Sets the orientation of the section to be either horizontal (true) or vertical false.
void	sortChildren(java.util.Comparator comparator)	Sorts children based on the specified comparator

Methods inherited from interface com.microstrategy.web.objects.rw.RWUnitDef

copyFormat, flushFormatChanges, getAllControlGroupBys, getElementControlGroupBys, getFilterDetailsFormatting, getFormat, getFormat, getFormat, getFormatTypes, getKey, getKeyContext, getName, getParent, getRwDefinition, getTheme, getThreshold, getThreshold, getThresholdCount, getTreeType, getType, isFirst, isLast, isVisible, nextSibling, prevSibling, revertToFormatDefaults, setName, setVisible

Methods inherited from interface com.microstrategy.web.objects.WebThresholdsContainer

getID, getObjectType, getThresholds, getTransactions, initElementSource

Method Detail

getGroupBy

RWGroupBy getGroupBy()

Returns a group by object associated with this section

Returns:

a group by object associated with this section

getGroupByLevel

int getGroupByLevel()

Returns a group by level of the section

Returns:

a group by level of the section

getChildCount

int getChildCount()

Return a number of children

Returns:

a number of children

getChild

RWUnitDef getChild(int index)

Returns i-th child unit definition.

Parameters:

index -

Returns:

i-th child unit definition

getChildByKey

RWUnitDef getChildByKey(java.lang.String key)

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

Parameters:

key -

Returns:

child definition with specified key.

addChild

RWUnitDef addChild(int unitType)

Adds the specified child unit

Parameters:

unitType - unit type

Returns:

the specified child unit

addChild

RWUnitDef addChild(int unitType,
                   java.lang.String unitKey)

Adds the specified child unit

Parameters:

unitType - unit type

unitKey - unit key

Returns:

added unit

addChild

RWUnitDef addChild(int unitType,
                   java.lang.String unitKey,
                   java.lang.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

removeChildByKey

RWUnitDef removeChildByKey(java.lang.String key)

Removes child unit with specified key

Parameters:

key -

Returns:

child unit with specified key

indexOf

int indexOf(RWUnitDef 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 - Comparator

addControl

RWControlDef addControl(java.lang.String key,
                        int type)

Adds control unit to this section

Parameters:

key - control unit key

type - control type

Returns:

new control unit

Since:

MicroStrategy Web 8.1.0

addControl

RWControlDef addControl(java.lang.String key,
                        int type,
                        java.lang.String ctlNodeKey)

addControl

RWControlDef addControl(java.lang.String key,
                        int type,
                        EnumWebControlSubType subType,
                        java.lang.String ctlNodeKey)

isHorizontal

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

Since:

MicroStrategy Web 9.0.0

setHorizontal

void setHorizontal(boolean isHorizontal)
            throws WebObjectsException

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

Since:

MicroStrategy Web 9.0.0

getFieldGroup

RWFieldGroupDef getFieldGroup()

Returns:

the filedGroup element in this section