public interface

WebHeaders

com.microstrategy.web.objects.WebHeaders

Class Overview

WebHeaders represent the group of headings that are laid out in a single table row, as is the case when laying out columns and row headers, which could span several table rows. For page headers, there can only be ONE group of WebHeaders retrieved from WebGridHeaders.

Summary

Public Methods
abstract Enumeration<WebHeader> elements()
abstract WebHeader get(int index)
Returns the WebHeader at the given index (starting from 0).
abstract WebHeader getCurrentElement()
Returns the WebHeader in this collection which has been selected as the current element.
abstract WebRow getGridRow()
Returns the grid row associated with this WebHeaders object.
abstract int getPositionInContainer()
returns the position of this collection in its container
abstract boolean isEmpty()
abstract int size()

Public Methods

public abstract Enumeration<WebHeader> elements ()

Returns

public abstract WebHeader get (int index)

Returns the WebHeader at the given index (starting from 0).

Parameters
index index of the element to return.
Returns
  • the element at the specified position.
Throws
IndexOutOfBoundsException if index is out of range (index < 0 || index >= size()).
See Also

public abstract WebHeader getCurrentElement ()

Returns the WebHeader in this collection which has been selected as the current element. This only makes sense for page headers. If no current element is found, null will be returned.

Returns
  • the current element.
Throws
UnsupportedOperationException if invoked from a row or column.

public abstract WebRow getGridRow ()

Returns the grid row associated with this WebHeaders object. Not supported in page and column headers.

Returns
  • the grid row.
Throws
UnsupportedOperationException if invoked from a page or column.

public abstract int getPositionInContainer ()

returns the position of this collection in its container

public abstract boolean isEmpty ()

public abstract int size ()

Returns
  • the number of WebHeader objects in the collection.