public class

BlockList

extends BlockListElement
java.lang.Object
   ↳ com.microstrategy.web.blocks.BlockTarget
     ↳ com.microstrategy.web.blocks.BlockListElement
       ↳ com.microstrategy.web.blocks.BlockList

Class Overview

This class represents a list in a Block.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.blocks.BlockTarget
Public Methods
void accept(BlockVisitor visitor)
Accept a BlockVisitor to this Block List.
void add(BlockListElement element)
Adds an existing BlockListElement to this list.
Block addNewBlock()
Block addNewBlock(String blockName)
void clear()
Empties the contents of this list.
BlockListElement get(int index)
Returns the BlockListElement at the specified index.
Block getElement(String listElementKey)
returns a Block whose list element is specified
BlockList putNewList()
BlockListElement remove(int index)
Removes a BlockListElement at a specified index from this list.
BlockListElement remove(String key)
Removes the BlockListElement whose list element key is specified.
int size()
Returns the number of elements in this list.
[Expand]
Inherited Methods
From class com.microstrategy.web.blocks.BlockListElement
From class com.microstrategy.web.blocks.BlockTarget
From class java.lang.Object

Public Methods

public void accept (BlockVisitor visitor)

Accept a BlockVisitor to this Block List. The visitor is notified in the following way:

  1. First, at the start of the list visitListStart(BlockList, BlockTarget).
  2. If the return code is true, then each of the list element elements is visited.
  3. Finally, at the end of the list visitListEnd(BlockList, BlockTarget).

Parameters
visitor The BlockVisitor instance.

public void add (BlockListElement element)

Adds an existing BlockListElement to this list. By default, this element is added to the end of the list. Properties of the BlockListElement can modify how it is added to the list.

Parameters
element The list element to add.

public Block addNewBlock ()

public Block addNewBlock (String blockName)

Throws
Exception

public void clear ()

Empties the contents of this list.

public BlockListElement get (int index)

Returns the BlockListElement at the specified index.

Parameters
index The index of the list element to return.
Returns

public Block getElement (String listElementKey)

returns a Block whose list element is specified

Parameters
listElementKey The list element key of the block to return
Returns
  • the Block with the same list element key if found.

public BlockList putNewList ()

public BlockListElement remove (int index)

Removes a BlockListElement at a specified index from this list.

Parameters
index The index of the list element to remove.
Returns

public BlockListElement remove (String key)

Removes the BlockListElement whose list element key is specified.

Parameters
key The list element key of the list element to remove.
Returns

public int size ()

Returns the number of elements in this list.

Returns
  • The number of elements in this list.