public interface

WebHeader

implements WebCssFormatContainer WebTransactableDataObject
com.microstrategy.web.objects.WebHeader
Known Indirect Subclasses

Class Overview

The WebHeader describes the contents of its associated row, column or page. Each WebHeader is displayed in association with a WebSubTitle.

Summary

Public Methods
abstract boolean canExpandCollapse()
abstract WebHeaders getChildren()
For page-tree style, each selected WebHeader determines what the remaining page headers would be displayed.
abstract int getColSpan()
abstract WebHeaders getContainer()
abstract int getDepth()
Returns the depth of the header.
abstract String getDisplayName()
abstract String getDrillElement()
abstract int getHeaderType()
Returns the type of this header from the enumeration EnumWebHeaderType.
abstract WebHeader getMergedChild()
Returns the merged child, if any, otherwise null.
abstract int getMix()
When this header is a header for a metric, returns the index of this header's metric within "Metrics" unit.
abstract int getOrdinal()
Returns the index number of the row/column/page, which this header is on.
abstract WebHeader getParent()
Returns the parent, if any, of this header.
abstract WebTitleUnit getParentTitleUnit()
abstract int getPositionInContainer()
abstract int getRALevel()
abstract String getRawValue()
Return raw data value of this header.
abstract int getRowSpan()
abstract int getSemantics()
The meaning of this form value.
abstract WebObjectInfo getTarget()
Returns the target of the header, if one exists.
abstract WebTitle getTitle()
abstract WebTitleUnit getTitleUnit(Boolean useParent)
abstract int getTotalType()
Only meaningful if isTotal() is true.
abstract int getTransactionAction()
return thresholdAction EnumDSSXMLTransactionAction
abstract int getUnitIndex()
Returns the index value of the corresponding template unit on the axis.
abstract WebElement getWebElement()
abstract int getWebElementIndex()
Returns the index position of getWebElement() in the getWebElements() collection returned by getWebElementsTitleUnit().
abstract int getWebElementIndex(Boolean useParent)
If parameter "useParent" is true this will return the index position of getWebElement() in getWebElements() collection returned by getParentTitleUnit().
abstract WebTitleUnit getWebElementsTitleUnit()
abstract boolean hasRaChildren()
abstract boolean isBeforeLast()
abstract boolean isCurrentElement()
Identifies whether the current header is the current (selected) element.
abstract boolean isCurrentSelectorElement()
returns true if the current element is the selected control element for a selector sourced at the owner template unit.
abstract boolean isDerivedElement()
abstract boolean isEditDisable()
Returns the unit can be edit or not.
abstract boolean isFirst()
abstract boolean isLast()
abstract boolean isLastRow()
abstract boolean isMultiForm()
abstract boolean isNDE()
abstract boolean isRaExpanded()
abstract boolean isSameAsParent()
This call identifies the current element as identical to its parent.
abstract boolean isTotal()
abstract void setTransactionAction(int action)
set thresholdAction EnumDSSXMLTransactionAction
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebCssFormatContainer
From interface com.microstrategy.web.objects.WebTransactableDataObject

Public Methods

public abstract boolean canExpandCollapse ()

Throws
WebObjectsException

public abstract 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.

public abstract int getColSpan ()

Returns
  • the column span.

public abstract WebHeaders getContainer ()

Returns
  • the encapsulating container where this WebHeader was obtained.

public abstract 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.

public abstract String getDisplayName ()

Returns
  • the display name of the header.

public abstract String getDrillElement ()

Returns
  • the drill element.

public abstract int getHeaderType ()

Returns the type of this header from the enumeration EnumWebHeaderType.

Returns

public abstract WebHeader getMergedChild ()

Returns the merged child, if any, otherwise null. The child header isSameAsParent() will return as true, and its getParent() is this header instance.

Returns
  • merged child

public abstract 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.

public abstract 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).

public abstract 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.

public abstract WebTitleUnit getParentTitleUnit ()

Returns
  • the WebTitleUnit associated with this instance.

public abstract int getPositionInContainer ()

public abstract int getRALevel ()

public abstract 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.

public abstract int getRowSpan ()

Returns
  • the row span.

public abstract 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 from EnumDSSXMLBaseFormType.

Returns

public abstract WebObjectInfo getTarget ()

Returns the target of the header, if one exists.

Returns
  • The first class target of the header.

public abstract WebTitle getTitle ()

Returns
  • the title encapsulating this WebHeader.

public abstract WebTitleUnit getTitleUnit (Boolean useParent)

public abstract int getTotalType ()

Only meaningful if isTotal() is true. Returns a value from EnumDSSXMLMetricType.

Returns

public abstract int getTransactionAction ()

return thresholdAction EnumDSSXMLTransactionAction

Returns
  • thresholdAction EnumDSSXMLTransactionAction

public abstract 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.

public abstract WebElement getWebElement ()

Returns
  • the WebElement associated with this WebHeader.
See Also

public abstract int getWebElementIndex ()

Returns the index position of getWebElement() in the getWebElements() collection returned by getWebElementsTitleUnit(). If no WebElement is present, -1 is returned. This is also equivalent to #getWebElementIndex(boolean) set to false.

public abstract int getWebElementIndex (Boolean useParent)

If parameter "useParent" is true this will return the index position of getWebElement() in getWebElements() collection returned by getParentTitleUnit(). Otherwise if parameter is false, it wlll use getWebElementsTitleUnit(). If the parameter is null, we will try to determine the setting automatically. If no WebElement is present, -1 is returned.

public abstract WebTitleUnit getWebElementsTitleUnit ()

Returns

public abstract boolean hasRaChildren ()

public abstract boolean isBeforeLast ()

Returns
  • if this is one before the last in the collection.

public abstract 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.

public abstract boolean isCurrentSelectorElement ()

returns true if the current element is the selected control element for a selector sourced at the owner template unit.

public abstract boolean isDerivedElement ()

public abstract boolean isEditDisable ()

Returns the unit can be edit or not.

Returns
  • the unit can be edit or not.

public abstract boolean isFirst ()

Returns
  • if this is the first element in the collection.

public abstract boolean isLast ()

Returns
  • if this is the last in the collection.

public abstract boolean isLastRow ()

Returns
  • if its WebHeaders container is the last in its collection (row and column headers only).

public abstract boolean isMultiForm ()

Returns
  • if this is multiform attribute.

public abstract boolean isNDE ()

public abstract boolean isRaExpanded ()

public abstract 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

public abstract boolean isTotal ()

Returns
  • whether header is a (sub)total.

public abstract void setTransactionAction (int action)

set thresholdAction EnumDSSXMLTransactionAction

Parameters
action EnumDSSXMLTransactionAction