Package com.microstrategy.web.objects

Interface WebGridTitles

  • All Superinterfaces:
    WebCssFormatContainer
    public interface WebGridTitles
extends WebCssFormatContainer
    This interface provides collection type methods to traverse and obtain WebTitle objects in the report.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • elements

        java.util.Enumeration elements()
        Returns:
        an enumeration of WebTitle objects.

      • size

        int size()
        Returns:
        the number of elements in this collection.

      • isEmpty

        boolean isEmpty()
        Returns:
        whether size()==0.

      • get

        WebTitle get​(int index)
        Returns the WebTitle 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:
        WebTitle

      • hasMetrics

        boolean hasMetrics()
        Returns a boolean indicating whether the metrics are present in the current collection of WebTitle objects. Using this, we can determine whether a particular axis contains the metrics
        Since:
        MicroStrategy Web 8.1.0

      • getResolvedTitleUnits

        java.util.List<? extends WebTitleUnit> getResolvedTitleUnits()
        This is the recommended means to obtain WebTitleUnit collections in each axis for display purposes. Each WebTitleUnit may be a WebTitle or WebSubTitle. The list returned is based on the following rules:
        • If attribute forms are shown:
          1. If a WebTitle has more than one WebSubTitle, each of the WebSubTitle are used
            2. .
          2. Otherwise if a WebTitle has exactly one WebSubTitle, the WebTitle is used.
        • Otherwise if no attribute forms are shown then only WebTitle are shown.
        Whether attribute forms are shown depend on the EnumWebPreferences.WebPreferenceGridShowSubtitle preference.

      • getResolvedTitleUnits

        java.util.List<? extends WebTitleUnit> getResolvedTitleUnits​(boolean forceShowAttributeForm)