Package com.microstrategy.web.objects
Interface WebTitleUnit
-
- All Known Subinterfaces:
WebSubTitle,WebTitle
public interface WebTitleUnitThis is a superclass ofWebTitleandWebSubTitle, 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 intgetAxisType()java.util.Enumeration<WebTitleUnit>getChildEnum()This will return a non-empty array iffgetTarget()returns aWebObjectInfo.getType()ofEnumDSSXMLObjectTypes.DssXmlTypeAttribute.java.lang.StringgetDisplayName()WebTitleUnitgetParent()intgetResolvedTitleUnitsIndex()Index of this unit in itsWebGridTitles.getResolvedTitleUnits()collection.intgetSpan()WebObjectInfogetTarget()java.util.List<WebElement>getWebElements()booleanisCurrentSelectorElement()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
WebObjectInfounderlying 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
WebHeaderinstances 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.
-
-