Package com.microstrategy.web.objects
Interface WebTitleUnit
-
- All Known Subinterfaces:
WebSubTitle
,WebTitle
public interface WebTitleUnit
This is a superclass ofWebTitle
andWebSubTitle
, and permits easy traversal of the title-subtitle tree.- Since:
- MicroStrategy Web 8.1.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getAxisType()
java.util.Enumeration<WebTitleUnit>
getChildEnum()
This will return a non-empty array iffgetTarget()
returns aWebObjectInfo.getType()
ofEnumDSSXMLObjectTypes.DssXmlTypeAttribute
.java.lang.String
getDisplayName()
WebTitleUnit
getParent()
int
getResolvedTitleUnitsIndex()
Index of this unit in itsWebGridTitles.getResolvedTitleUnits()
collection.int
getSpan()
WebObjectInfo
getTarget()
java.util.List<WebElement>
getWebElements()
boolean
isCurrentSelectorElement()
returns true if the current element is the selected control element for a selector sourced at the owner template unit.
-
-
-
Method Detail
-
getParent
WebTitleUnit getParent()
- Returns:
- parent of this
WebTitleUnit
, and null if none.
-
getSpan
int getSpan()
- Returns:
- the span (columns/rows) of the title.
-
getTarget
WebObjectInfo getTarget() throws WebObjectsException
- Returns:
- the
WebObjectInfo
underlying thisWebTitleUnit
. - Throws:
WebObjectsException
-
getChildEnum
java.util.Enumeration<WebTitleUnit> getChildEnum()
This will return a non-empty array iffgetTarget()
returns aWebObjectInfo.getType()
ofEnumDSSXMLObjectTypes.DssXmlTypeAttribute
.- Returns:
- unique elements referenced by
WebHeader
instances under this title.
-
getWebElements
java.util.List<WebElement> getWebElements()
-
getResolvedTitleUnitsIndex
int getResolvedTitleUnitsIndex()
Index of this unit in itsWebGridTitles.getResolvedTitleUnits()
collection.
-
getDisplayName
java.lang.String getDisplayName()
-
getAxisType
int getAxisType()
- Returns:
- type
EnumDSSXMLAxisName
.
-
isCurrentSelectorElement
boolean isCurrentSelectorElement()
returns true if the current element is the selected control element for a selector sourced at the owner template unit.
-
-