Package com.microstrategy.web.objects
Interface WebHeader
-
- All Superinterfaces:
WebCssFormatContainer
,WebTransactableDataObject
- All Known Subinterfaces:
WebAttributeHeader
,WebDimensionHeader
,WebMetricHeader
public interface WebHeader extends WebCssFormatContainer, WebTransactableDataObject
The WebHeader describes the contents of its associated row, column or page. Each WebHeader is displayed in association with aWebSubTitle
.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
canExpandCollapse()
java.lang.String
getCellColor()
DE22117WebHeaders
getChildren()
For page-tree style, each selected WebHeader determines what the remaining page headers would be displayed.int
getColSpan()
WebHeaders
getContainer()
int
getDepth()
Returns the depth of the header.java.lang.String
getDisplayName()
java.lang.String
getDrillElement()
int
getHeaderType()
Returns the type of this header from the enumeration EnumWebHeaderType.WebHeader
getMergedChild()
Returns the merged child, if any, otherwise null.int
getMix()
When this header is a header for a metric, returns the index of this header's metric within "Metrics" unit.int
getOrdinal()
Returns the index number of the row/column/page, which this header is on.WebHeader
getParent()
Returns the parent, if any, of this header.WebTitleUnit
getParentTitleUnit()
int
getPositionInContainer()
int
getRALevel()
java.lang.String
getRawValue()
Return raw data value of this header.int
getRowSpan()
int
getSemantics()
The meaning of this form value.WebObjectInfo
getTarget()
Returns the target of the header, if one exists.int
getThresholdIndex()
Returns the threshold index value of the corresponding template unit on the axis.WebTitle
getTitle()
WebTitleUnit
getTitleUnit(java.lang.Boolean useParent)
int
getTotalType()
Only meaningful ifisTotal()
is true.int
getTransactionAction()
return thresholdActionEnumDSSXMLTransactionAction
int
getUnitIndex()
Returns the index value of the corresponding template unit on the axis.WebElement
getWebElement()
int
getWebElementIndex()
Returns the index position ofgetWebElement()
in theWebTitleUnit.getWebElements()
collection returned bygetWebElementsTitleUnit()
.int
getWebElementIndex(java.lang.Boolean useParent)
If parameter "useParent" is true this will return the index position ofgetWebElement()
inWebTitleUnit.getWebElements()
collection returned bygetParentTitleUnit()
.WebTitleUnit
getWebElementsTitleUnit()
boolean
hasRaChildren()
boolean
isBeforeLast()
boolean
isCurrentElement()
Identifies whether the current header is the current (selected) element.boolean
isCurrentSelectorElement()
returns true if the current element is the selected control element for a selector sourced at the owner template unit.boolean
isDerivedElement()
boolean
isEditDisable()
Returns the unit can be edit or not.boolean
isFirst()
boolean
isLast()
boolean
isLastRow()
boolean
isMultiForm()
boolean
isNDE()
boolean
isRaExpanded()
boolean
isSameAsParent()
This call identifies the current element as identical to its parent.boolean
isTotal()
void
setTransactionAction(int action)
set thresholdActionEnumDSSXMLTransactionAction
-
Methods inherited from interface com.microstrategy.web.objects.WebCssFormatContainer
getCssClass, getCssFormat, getFormatPropertySets
-
Methods inherited from interface com.microstrategy.web.objects.WebTransactableDataObject
isModifiedByTransaction
-
-
-
-
Method Detail
-
getColSpan
int getColSpan()
- Returns:
- the column span.
-
getRowSpan
int getRowSpan()
- Returns:
- the row span.
-
getOrdinal
int getOrdinal()
Returns the index number of the row/column/page, which this header is on. The number starts from "0" and increases in the grid. This remains true even if a partial report is retrieved.- Returns:
- the row/column/page ordinal (index) of the header (starting from 0).
-
getDepth
int getDepth()
Returns the depth of the header. Depth is the index (start from 1) of the header in the axis.- Returns:
- the depth of the header.
-
getUnitIndex
int getUnitIndex()
Returns the index value of the corresponding template unit on the axis.- Returns:
- the index (start from 1) of the corresponding template unit on the axis.
-
getSemantics
int getSemantics()
The meaning of this form value. This implies, but is not the same as the data type. Values of this attribute are derived fromEnumDSSXMLBaseFormType
.- Returns:
- the semantic type (see
EnumDSSXMLBaseFormType
).
-
getThresholdIndex
int getThresholdIndex()
Returns the threshold index value of the corresponding template unit on the axis.- Returns:
- the threshold index (start from 1) of the corresponding template unit on the axis.
-
isCurrentElement
boolean isCurrentElement()
Identifies whether the current header is the current (selected) element. This may or may not return a meaningful value in the context of a row or column header.- Returns:
- whether this is the current element.
-
isCurrentSelectorElement
boolean isCurrentSelectorElement()
returns true if the current element is the selected control element for a selector sourced at the owner template unit.- Since:
- MicroStrategy Web 8.1.0
-
isSameAsParent
boolean isSameAsParent()
This call identifies the current element as identical to its parent. For row headers, aggregates (such as subtotals, totals) often span several columns - the header in such cases are replicated (they have different depth values), but are essentially the same header element.- Returns:
- whether this header is congruent to its parent.
- See Also:
getParent()
-
isFirst
boolean isFirst()
- Returns:
- if this is the first element in the collection.
-
isLast
boolean isLast()
- Returns:
- if this is the last in the collection.
-
isBeforeLast
boolean isBeforeLast()
- Returns:
- if this is one before the last in the collection.
-
isMultiForm
boolean isMultiForm()
- Returns:
- if this is multiform attribute.
-
isLastRow
boolean isLastRow()
- Returns:
- if its
WebHeaders
container is the last in its collection (row and column headers only). - Since:
- MicroStrategy Web 7.5.1
-
getWebElement
WebElement getWebElement()
- Returns:
- the WebElement associated with this WebHeader.
- See Also:
WebElement
-
getWebElementIndex
int getWebElementIndex()
Returns the index position ofgetWebElement()
in theWebTitleUnit.getWebElements()
collection returned bygetWebElementsTitleUnit()
. If noWebElement
is present, -1 is returned. This is also equivalent to#getWebElementIndex(boolean)
set to false.
-
getWebElementIndex
int getWebElementIndex(java.lang.Boolean useParent)
If parameter "useParent" is true this will return the index position ofgetWebElement()
inWebTitleUnit.getWebElements()
collection returned bygetParentTitleUnit()
. Otherwise if parameter is false, it wlll usegetWebElementsTitleUnit()
. If the parameter is null, we will try to determine the setting automatically. If noWebElement
is present, -1 is returned.
-
getTitleUnit
WebTitleUnit getTitleUnit(java.lang.Boolean useParent)
-
getTitle
WebTitle getTitle()
- Returns:
- the title encapsulating this WebHeader.
-
getChildren
WebHeaders getChildren()
For page-tree style, each selected WebHeader determines what the remaining page headers would be displayed. This is expressed in a hierarchical fashion by this method. Page-tree style is typically used for rendering dynamic menus. This will return null if there are no children, or if the report was rendered with the normal (non page-tree) style.- Returns:
- valid headers for next title group.
-
getContainer
WebHeaders getContainer()
- Returns:
- the encapsulating container where this WebHeader was obtained.
-
getPositionInContainer
int getPositionInContainer()
-
getParent
WebHeader getParent()
Returns the parent, if any, of this header. This depends upon the axis of the header: the header to the left if it's a row header, the header above if it's a column header, and the previous header in the drop down list for a page by header. For row and column headers, this will also retrieve the correct parent even if the parent header is merged (spans several rows/columns).- Returns:
- the logical parent of the header.
-
getHeaderType
int getHeaderType()
Returns the type of this header from the enumeration EnumWebHeaderType.- Returns:
- the
EnumWebHeaderType
.
-
getDisplayName
java.lang.String getDisplayName()
- Returns:
- the display name of the header.
-
getRawValue
java.lang.String getRawValue()
Return raw data value of this header.- Returns:
- String The raw data value of this header, which is the unformatted display name.
Return
null
when there is no raw value specified for this header. - Since:
- MicroStrategy Web 7.5.4
-
getMix
int getMix()
When this header is a header for a metric, returns the index of this header's metric within "Metrics" unit.- Returns:
- the metric index.
-
getDrillElement
java.lang.String getDrillElement()
- Returns:
- the drill element.
-
getWebElementsTitleUnit
WebTitleUnit getWebElementsTitleUnit()
- Returns:
- the shared
WebTitleUnit
withgetWebElementIndex()
references. - Since:
- MicroStrategy Web 8.1.2
-
getParentTitleUnit
WebTitleUnit getParentTitleUnit()
- Returns:
- the
WebTitleUnit
associated with this instance. - Since:
- MicroStrategy Web 8.1.2
-
isTotal
boolean isTotal()
- Returns:
- whether header is a (sub)total.
- Since:
- MicroStrategy Web 8.1.1
-
isDerivedElement
boolean isDerivedElement()
- Since:
- MicroStrategy Web 9.0.0
-
getTotalType
int getTotalType()
Only meaningful ifisTotal()
is true. Returns a value fromEnumDSSXMLMetricType
.- Returns:
- Value from
EnumDSSXMLMetricType
- Since:
- MicroStrategy Web 9.0.0
-
getMergedChild
WebHeader getMergedChild()
Returns the merged child, if any, otherwise null. The child headerisSameAsParent()
will return as true, and itsgetParent()
is this header instance.- Returns:
- merged child
- Since:
- MicroStrategy Web 9.0.0
-
getRALevel
int getRALevel()
-
getTarget
WebObjectInfo getTarget()
Returns the target of the header, if one exists.- Returns:
- The first class target of the header.
- Since:
- MicroStrategy Web 9.0.0
-
isRaExpanded
boolean isRaExpanded()
-
hasRaChildren
boolean hasRaChildren()
-
canExpandCollapse
boolean canExpandCollapse() throws WebObjectsException
- Throws:
WebObjectsException
-
isEditDisable
boolean isEditDisable()
Returns the unit can be edit or not.- Returns:
- the unit can be edit or not.
-
setTransactionAction
void setTransactionAction(int action)
set thresholdActionEnumDSSXMLTransactionAction
- Parameters:
action
-EnumDSSXMLTransactionAction
-
getTransactionAction
int getTransactionAction()
return thresholdActionEnumDSSXMLTransactionAction
- Returns:
- thresholdAction
EnumDSSXMLTransactionAction
-
isNDE
boolean isNDE()
-
getCellColor
java.lang.String getCellColor()
DE22117- Returns:
- the cell color
-
-