Package com.microstrategy.web.objects

Interface WebTitle

All Superinterfaces:

WebCssFormatContainer, WebTitleUnit

public interface WebTitle
extends WebTitleUnit, WebCssFormatContainer

The WebTitle interface describes various properties in a report grid page title, column title or row title.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
int	getDepth()
WebDrillMap	getDrillMap()	Returns the WebDrillMap associated with this title.
WebDrillMap	getGridDrillMap()	Returns the WebDrillMap which defined on grid level.
WebSubTitles	getGridSubTitles()	Returns the WebSubTitles under this title.
int	getHeaderCount()
int	getPosition()	Returns the position of the title with respect to its placement of the other titles along its given axis.
int	getSpan()
WebObjectInfo	getTarget()
int	getType()	Returns the object type of the WebTitle.
WebTemplateUnit	getWebTemplateUnit()
boolean	hasRuntimeUnitLimit()
boolean	isFirst()
boolean	isLast()

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

getCssClass, getCssFormat, getFormatPropertySets

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

getAxisType, getChildEnum, getDisplayName, getParent, getResolvedTitleUnitsIndex, getWebElements, isCurrentSelectorElement

Method Detail

getWebTemplateUnit

WebTemplateUnit getWebTemplateUnit()
                            throws WebObjectsException

Returns:

the WebTemplateUnit associated with this title.

Throws:

WebObjectsException - if an error occurs while retrieving the template.

getSpan

int getSpan()

Specified by:

getSpan in interface WebTitleUnit

Returns:

the span (columns/rows) of the title.

getDepth

int getDepth()

Returns:

depth of the title (starting from 1).

getHeaderCount

int getHeaderCount()

Returns:

the number of headers encapsulated by this title.

getType

int getType()

Returns the object type of the WebTitle. The possible types returned are: EnumDSSXMLTemplateUnitType.DssXmlTemplateAttribute, EnumDSSXMLTemplateUnitType.DssXmlTemplateMetrics, EnumDSSXMLTemplateUnitType.DssXmlTemplateConsolidation, EnumDSSXMLTemplateUnitType.DssXmlTemplateCustomGroup, EnumDSSXMLTemplateUnitType.DssXmlTemplateDimension.

Returns:

a type EnumDSSXMLTemplateUnitType.

See Also:

EnumDSSXMLTemplateUnitType

getPosition

int getPosition()

Returns the position of the title with respect to its placement of the other titles along its given axis. Also known as the unit index, the position counts begins from 1.

Returns:

the position/unit index (starts from 1).

getGridSubTitles

WebSubTitles getGridSubTitles()

Returns the WebSubTitles under this title. The WebSubTitles collection is never null.

Returns:

the WebSubTitles (if any) encapsulated by this title.

getDrillMap

WebDrillMap getDrillMap()

Returns the WebDrillMap associated with this title. The WebDrillMap is never null.

Returns:

the WebDrillMap (if any) encapsulated by this title.

getGridDrillMap

WebDrillMap getGridDrillMap()

Returns the WebDrillMap which defined on grid level.

Returns:

the WebDrillMap

getTarget

WebObjectInfo getTarget()
                 throws WebObjectsException

Specified by:

getTarget in interface WebTitleUnit

Returns:

the WebObjectInfo describing this title object.

Throws:

WebObjectsException

isFirst

boolean isFirst()

Returns:

if this is the first WebTitle in the collection.

isLast

boolean isLast()

Returns:

if this is the last WebTitle in the collection.

hasRuntimeUnitLimit

boolean hasRuntimeUnitLimit()

Returns:

if there is any runtime unit limit applied to this title.