Package com.microstrategy.web.objects

Interface WebHeaders

  • public interface WebHeaders
    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.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • elements

        java.util.Enumeration<WebHeader> elements()
        Returns:
        an enumeration of WebHeader objects.

      • size

        int size()
        Returns:
        the number of WebHeader objects in the collection.

      • getPositionInContainer

        int getPositionInContainer()
        returns the position of this collection in its container
        Returns:

      • get

        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:
        java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= size()).
        See Also:
        WebHeader

      • isEmpty

        boolean isEmpty()

      • getGridRow

        WebRow getGridRow()
        Returns the grid row associated with this WebHeaders object. Not supported in page and column headers.
        Returns:
        the grid row.
        Throws:
        java.lang.UnsupportedOperationException - if invoked from a page or column.

      • getCurrentElement

        WebHeader getCurrentElement()
                     throws java.lang.UnsupportedOperationException
        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:
        java.lang.UnsupportedOperationException - if invoked from a row or column.