RWLayoutSectionDef

implements RWSectionDef

com.microstrategy.web.objects.rw.RWLayoutSectionDef

Class Overview

Represents layout section of multi-layout document.

Summary

Public Methods
abstract String	getName() This is a convenience method for reading the name of the object This is equivalent to reading the name property from the FormattingAppearance propertySet of the format definition associated with this object
abstract WebVisualizationSettings	getVisualizationSettings()
abstract boolean	hasGroupBys()
abstract boolean	isCurrent() Returns true if the section is current

[Expand]

Inherited Methods

From interface com.microstrategy.web.objects.WebThresholdsContainer

From interface com.microstrategy.web.objects.rw.RWSectionDef

abstract RWUnitDef	addChild(int unitType, String unitKey, String beforeKey) Adds the specified child unit
abstract RWUnitDef	addChild(int unitType) Adds the specified child unit
abstract RWUnitDef	addChild(int unitType, String unitKey) Adds the specified child unit
abstract RWControlDef	addControl(String key, int type, String ctlNodeKey)
abstract RWControlDef	addControl(String key, int type) Adds control unit to this section
abstract RWControlDef	addControl(String key, int type, EnumWebControlSubType subType, String ctlNodeKey)
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

From interface com.microstrategy.web.objects.rw.RWUnitDef

abstract void	copyFormat(RWUnitDef fromUnit) Copies formatting properties from the fromUnit to this unit.
abstract void	flushFormatChanges(boolean applyToAllViews) flush the current formatting manipulations, so that it would be submitted to iserver if needed.
abstract List	getAllControlGroupBys() Returns a list of all the controlGroupBys `RWControlGroupBy` on this unit including element selector and metric selector targeting control groupBys
abstract RWControlGroupBys	getElementControlGroupBys() Returns a `RWControlGroupBys` object, which is a collection of all element selection `RWControlGroupBy` objects
abstract FilterDetailsFormatting	getFilterDetailsFormatting()
abstract WebFormat	getFormat(int formatType) Returns a format object for the given format type.
abstract WebFormat	getFormat(String id) This method is deprecated. use `getFormat()` via `getThresholds()` and `get(String)`
abstract WebFormat	getFormat() Returns formatting object
abstract int[]	getFormatTypes() Returns a list of format types applicable to the given object
abstract String	getKey() Returns unit ID
abstract String	getKeyContext() Returns a unique id to be used by the backend to identify any unit.
abstract String	getName() This is a convenience method for reading the name of the object This is equivalent to reading the name property from the FormattingAppearance propertySet of the format definition associated with this object
abstract RWSectionDef	getParent() Returns unit's parent
abstract RWDefinition	getRwDefinition() Returns parent RwDefiniton
abstract WebTheme	getTheme()
abstract RWThreshold	getThreshold(int i) This method is deprecated. use `get(int)` via `getThresholds()`
abstract RWThreshold	getThreshold(String id) This method is deprecated. use `get(String)` via `getThresholds()`
abstract int	getThresholdCount() This method is deprecated. use `size()` via `getThresholds()`
abstract String	getTreeType()
abstract int	getType() Returns unit type
abstract boolean	isFirst() Returns true if this unit is the first on its parent collection
abstract boolean	isLast() Returns true if this unit is the last on its parent collection
abstract boolean	isVisible() Retyrns true if this unit is visible
abstract RWUnitDef	nextSibling() Returns next sibleng
abstract RWUnitDef	prevSibling() Returns previous sibling
abstract void	revertToFormatDefaults() Resets the unit's format to the control default values
abstract void	setName(String name) This is a convenience method for setting the name of the object This is equivalent to setting the name property from the FormattingAppearance propertySet of the format definition associated with this object
abstract void	setVisible(boolean value) Sets visible property on the unit

Public Methods

public abstract String getName ()

This is a convenience method for reading the name of the object This is equivalent to reading the name property from the FormattingAppearance propertySet of the format definition associated with this object

Returns

name

public abstract WebVisualizationSettings getVisualizationSettings ()

Throws

WebObjectsException

Interfaces

Classes

Enums

RWLayoutSectionDef

Class Overview

Summary

Public Methods

public abstract String getName ()

Returns

public abstract WebVisualizationSettings getVisualizationSettings ()

Throws

public abstract boolean hasGroupBys ()

public abstract boolean isCurrent ()

Returns