Package com.microstrategy.web.objects
Interface WebSubTitle
-
- All Superinterfaces:
WebTitleUnit
public interface WebSubTitle extends WebTitleUnit
A WebSubTitle is the finest granularity of title type labels, and if it is a leaf node (no more embedded child WebSubTitles). EveryWebHeaderis associated with a WebSubTitle.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description intgetBaseFormID()Returns the base form ID associated with this subtitleintgetIndex()Returns position of WebSubTitle with respect to its container (starting from 1).java.lang.StringgetName()WebSubTitlesgetSubTitles()Returns the embedded WebSubTitles in the hierarchy.WebObjectInfogetTarget()-
Methods inherited from interface com.microstrategy.web.objects.WebTitleUnit
getAxisType, getChildEnum, getDisplayName, getParent, getResolvedTitleUnitsIndex, getSpan, getWebElements, isCurrentSelectorElement
-
-
-
-
Method Detail
-
getName
java.lang.String getName()
- Returns:
- the display name.
-
getTarget
WebObjectInfo getTarget() throws WebObjectsException
- Specified by:
getTargetin interfaceWebTitleUnit- Returns:
- the
WebObjectInfodescribing the WebSubTitle. - Throws:
WebObjectsException
-
getSubTitles
WebSubTitles getSubTitles()
Returns the embedded WebSubTitles in the hierarchy. Null if not found.- Returns:
- the embedded WebSubTitles (if any).
-
getIndex
int getIndex()
Returns position of WebSubTitle with respect to its container (starting from 1).
-
getBaseFormID
int getBaseFormID()
Returns the base form ID associated with this subtitle- Returns:
- int base form ID
-
-