| com.microstrategy.web.objects.WebTitle |
Class Overview
The WebTitle interface describes various properties in a report grid page title, column title or row title.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract int | getDepth() | ||||||||||
| abstract WebDrillMap |
getDrillMap()
Returns the WebDrillMap associated with this title.
| ||||||||||
| abstract WebDrillMap |
getGridDrillMap()
Returns the WebDrillMap which defined on grid level.
| ||||||||||
| abstract WebSubTitles |
getGridSubTitles()
Returns the WebSubTitles under this title.
| ||||||||||
| abstract int | getHeaderCount() | ||||||||||
| abstract int |
getPosition()
Returns the position of the title with respect to its placement
of the other titles along its given axis.
| ||||||||||
| abstract int | getSpan() | ||||||||||
| abstract WebObjectInfo | getTarget() | ||||||||||
| abstract int |
getType()
Returns the object type of the WebTitle.
| ||||||||||
| abstract WebTemplateUnit | getWebTemplateUnit() | ||||||||||
| abstract boolean | hasRuntimeUnitLimit() | ||||||||||
| abstract boolean | isFirst() | ||||||||||
| abstract boolean | isLast() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.microstrategy.web.objects.WebCssFormatContainer
| |||||||||||
|
From interface
com.microstrategy.web.objects.WebTitleUnit
| |||||||||||
Public Methods
public abstract int getDepth ()
Returns
- depth of the title (starting from 1).
public abstract WebDrillMap getDrillMap ()
Returns the WebDrillMap associated with this title. The WebDrillMap is never null.
Returns
- the
WebDrillMap(if any) encapsulated by this title.
public abstract WebDrillMap getGridDrillMap ()
Returns the WebDrillMap which defined on grid level.
Returns
- the
WebDrillMap
public abstract WebSubTitles getGridSubTitles ()
Returns the WebSubTitles under this title. The WebSubTitles collection is never null.
Returns
- the
WebSubTitles(if any) encapsulated by this title.
public abstract int getHeaderCount ()
Returns
- the number of headers encapsulated by this title.
public abstract 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).
public abstract int getSpan ()
Returns
- the span (columns/rows) of the title.
public abstract WebObjectInfo getTarget ()
public abstract int getType ()
Returns the object type of the WebTitle. The possible types returned are:
DssXmlTemplateAttribute,
DssXmlTemplateMetrics,
DssXmlTemplateConsolidation,
DssXmlTemplateCustomGroup,
DssXmlTemplateDimension.
Returns
- a type
EnumDSSXMLTemplateUnitType.
See Also
public abstract WebTemplateUnit getWebTemplateUnit ()
Returns
- the
WebTemplateUnitassociated with this title.
Throws
| WebObjectsException | if an error occurs while retrieving the template. |
|---|
public abstract boolean hasRuntimeUnitLimit ()
Returns
- if there is any runtime unit limit applied to this title.
public abstract boolean isFirst ()
Returns
- if this is the first WebTitle in the collection.
public abstract boolean isLast ()
Returns
- if this is the last WebTitle in the collection.