Package com.microstrategy.web.blocks

Class BlockList

java.lang.Object

com.microstrategy.web.blocks.BlockTarget

com.microstrategy.web.blocks.BlockListElement

com.microstrategy.web.blocks.BlockList

All Implemented Interfaces:

java.io.Serializable

public class BlockList
extends BlockListElement

This class represents a list in a Block.

Since:

MicroStrategy Web 8.1.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.blocks.BlockListElement

BlockListElement.ListAction

Nested classes/interfaces inherited from class com.microstrategy.web.blocks.BlockTarget

BlockTarget.PathInfo

Field Summary

Fields inherited from class com.microstrategy.web.blocks.BlockTarget

TARGETTYPE_BLOCK, TARGETTYPE_LIST, TARGETTYPE_PROPERTY

Method Summary

Modifier and Type	Method	Description
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(java.lang.String blockName)
void	clear()	Empties the contents of this list.
BlockListElement	get(int index)	Returns the BlockListElement at the specified index.
Block	getElement(java.lang.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(java.lang.String key)	Removes the BlockListElement whose list element key is specified.
int	size()	Returns the number of elements in this list.

Methods inherited from class com.microstrategy.web.blocks.BlockListElement

getListAction, getListElementKey, getListItem, setListAction, setListElementKey, setListItem, setListItem

Methods inherited from class com.microstrategy.web.blocks.BlockTarget

findProperties, getTargetType, resolvePath, resolvePath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

size

public int size()

Returns the number of elements in this list.

Returns:

The number of elements in this list.

get

public BlockListElement get(int index)

Returns the BlockListElement at the specified index.

Parameters:

index - The index of the list element to return.

Returns:

The BlockListElement to return.

add

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.

See Also:

BlockListElement.ListAction, BlockListElement.setListAction(ListAction), BlockListElement.setListItem(int), BlockListElement.setListItem(String)

addNewBlock

public Block addNewBlock()

addNewBlock

public Block addNewBlock(java.lang.String blockName)
                  throws java.lang.Exception

Throws:

java.lang.Exception

putNewList

public BlockList putNewList()

clear

public void clear()

Empties the contents of this list.

remove

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:

The BlockListElement that was removed.

remove

public BlockListElement remove(java.lang.String key)

Removes the BlockListElement whose list element key is specified.

Parameters:

key - The list element key of the list element to remove.

Returns:

The BlockListElement that was removed.

Since:

MicroStrategy Web 9.0.0

accept

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 BlockVisitor.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 BlockVisitor.visitListEnd(BlockList, BlockTarget).

Parameters:

visitor - The BlockVisitor instance.

Since:

MicroStrategy Web 9.0.0

getElement

public Block getElement(java.lang.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.

Since:

MicroStrategy Web 9.0.1