ListTag (Web API 2021)

All Superinterfaces:

DynamicTag, EnumHTMLTags, Tag
```
public interface ListTag
extends DynamicTag
```
The ListTag interface provides a list of values at the runtime when it gets rendered. Furthermore the generated list of values is cached in a LayoutContext object and is retrievable through the list name. The Tag.render(com.microstrategy.web.beans.MarkupOutput, LayoutContext) method automatically loops through all the list elements to render its children as many times as the number of list elements. At the end of the rendering method, the list is removed from the LayoutContext object.

Since:

MicroStrategy Web 8.0.0

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ATTR_NAME_LIST_NAME`	The constant name of the attribute `id`.
`static java.lang.String`	`TAG_NAME_LIST`	The constant name of the `ListTag`.

Fields inherited from interface com.microstrategy.web.tags.DynamicTag
ATTR_NAME_METHOD, ATTR_NAME_METHOD_BASE, ATTR_NAME_NAME, METHOD_SOURCE_BEAN, METHOD_SOURCE_BEAN_NAME, METHOD_SOURCE_OBJECT, METHOD_SOURCE_TRANSFORM, METHOD_SOURCE_TRANSFORM_NAME

Fields inherited from interface com.microstrategy.web.tags.EnumHTMLTags
ATT_ACTION, ATT_ALIGN, ATT_ALT, ATT_AUTOCOMPLETE, ATT_BORDER, ATT_CELLPADDING, ATT_CELLSPACING, ATT_CHECKED, ATT_CLASS, ATT_CMD_FORMAT_TYPE, ATT_CMDID, ATT_CMDLVL, ATT_COLS, ATT_COLSPAN, ATT_DG, ATT_DIALOG, ATT_DISABLED, ATT_FOR, ATT_HEIGHT, ATT_HREF, ATT_HSPACE, ATT_ID, ATT_IFRAME, ATT_LANGUAGE, ATT_MAXLENGTH, ATT_METHOD, ATT_MODAL, ATT_NAME, ATT_NOWRAP, ATT_ONCHANGE, ATT_ONCLICK, ATT_ONFOCUS, ATT_ONKEYDOWN, ATT_ONKEYUP, ATT_ONMOUSEOUT, ATT_ONMOUSEOVER, ATT_ONSUBMIT, ATT_PARAM, ATT_PLACEHOLDER, ATT_READONLY, ATT_REL, ATT_ROWS, ATT_ROWSPAN, ATT_SCRIPT_CLASS, ATT_SELECTED, ATT_SIZE, ATT_SRC, ATT_STYLE, ATT_SUMMARY, ATT_TARGET, ATT_TITLE, ATT_TY, ATT_TYPE, ATT_VALIGN, ATT_VALUE, ATT_VALUE_ABSBOTTOM, ATT_VALUE_ABSMIDDLE, ATT_VALUE_BOTTOM, ATT_VALUE_BUTTON, ATT_VALUE_CHECKBOX, ATT_VALUE_DEFAULT, ATT_VALUE_EMBED, ATT_VALUE_FALSE, ATT_VALUE_HIDDEN, ATT_VALUE_IMAGE, ATT_VALUE_JAVASCRIPT, ATT_VALUE_LEFT, ATT_VALUE_MAX, ATT_VALUE_MIDDLE, ATT_VALUE_MIN, ATT_VALUE_NUMBER, ATT_VALUE_POST, ATT_VALUE_RADIO, ATT_VALUE_SUBMIT, ATT_VALUE_TEXT, ATT_VALUE_TOP, ATT_VALUE_TRUE, ATT_VSPACE, ATT_WIDTH, TAG_NAME_ANCHOR, TAG_NAME_CELL, TAG_NAME_DIV, TAG_NAME_HEADER, TAG_NAME_IFRAME, TAG_NAME_IMAGE, TAG_NAME_INPUT, TAG_NAME_LABEL, TAG_NAME_MAP, TAG_NAME_OPTION, TAG_NAME_ROW, TAG_NAME_SCRIPT, TAG_NAME_SELECT, TAG_NAME_SPAN, TAG_NAME_STYLE, TAG_NAME_TABLE, TAG_NAME_TBODY, TAG_NAME_TEXTAREA, TAG_NAME_THEAD

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getListName()`	Returns the name of the current list.
`void`	`setListName(java.lang.String listName)`	Sets a name to the current list.

Methods inherited from interface com.microstrategy.web.tags.DynamicTag
addArgument, addOnException, getArguments, getMethodName, getMethodSource, getOnExceptions, invokeMethod, setMethodName, setMethodSource

Methods inherited from interface com.microstrategy.web.tags.Tag
addChild, addChild, addChild, addTextChild, addTextChild, doEndTag, doStartTag, getAttribute, getAttributeNames, getChildren, getContent, getCssClass, getDeepCopy, getId, getLineNumber, getPreserveCase, getRootTag, getSealed, getStyle, getTagName, isClosedRequired, isContentInline, isDynamic, removeChildren, render, render, renderCloseTag, renderOpenTag, renderOpenTag, replaceContent, setAttribute, setAttributes, setCssClass, setDynamic, setId, setIsClosedRequired, setIsContentInline, setLineNumber, setPreserveCase, setRootTag, setSealed, setStyle, setTagName

- Field Detail
  - TAG_NAME_LIST
```
static final java.lang.String TAG_NAME_LIST
```
    The constant name of the ListTag.
    
    See Also:
    
    Constant Field Values
  - ATTR_NAME_LIST_NAME
```
static final java.lang.String ATTR_NAME_LIST_NAME
```
    The constant name of the attribute id.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getListName
```
java.lang.String getListName()
```
    Returns the name of the current list. It is actually the value of the attribute ATTR_NAME_LIST_NAME.
    
    Returns:
    
    the name of the currrent list.
  - setListName
```
void setListName(java.lang.String listName)
          throws UnmodifiableException
```
    Sets a name to the current list. It is actually the value of the attribute ATTR_NAME_LIST_NAME.
    
    Parameters:
    
    listName - a new name of the current list.
    
    Throws:
    
    UnmodifiableException - thrown if the current tag is read-only.