Package com.microstrategy.web.objects
Interface WebGridTitles
-
- All Superinterfaces:
WebCssFormatContainer
public interface WebGridTitles extends WebCssFormatContainer
This interface provides collection type methods to traverse and obtainWebTitle
objects in the report.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Enumeration
elements()
WebTitle
get(int index)
Returns the WebTitle at the given index (starting from 0).java.util.List<? extends WebTitleUnit>
getResolvedTitleUnits()
This is the recommended means to obtainWebTitleUnit
collections in each axis for display purposes.java.util.List<? extends WebTitleUnit>
getResolvedTitleUnits(boolean forceShowAttributeForm)
boolean
hasMetrics()
Returns a boolean indicating whether the metrics are present in the current collection ofWebTitle
objects.boolean
isEmpty()
int
size()
-
Methods inherited from interface com.microstrategy.web.objects.WebCssFormatContainer
getCssClass, getCssFormat, getFormatPropertySets
-
-
-
-
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 ofWebTitle
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 obtainWebTitleUnit
collections in each axis for display purposes. EachWebTitleUnit
may be aWebTitle
orWebSubTitle
. The list returned is based on the following rules:- If attribute forms are shown:
- If a
WebTitle
has more than oneWebSubTitle
, each of theWebSubTitle
are used .
- Otherwise if a
WebTitle
has exactly oneWebSubTitle
, theWebTitle
is used.
- If a
- Otherwise if no attribute forms are shown then only
WebTitle
are shown.
EnumWebPreferences.WebPreferenceGridShowSubtitle
preference. - If attribute forms are shown:
-
getResolvedTitleUnits
java.util.List<? extends WebTitleUnit> getResolvedTitleUnits(boolean forceShowAttributeForm)
-
-