org.xwiki.rendering.block
Class GroupBlock

java.lang.Object
  org.xwiki.rendering.block.AbstractBlock
      org.xwiki.rendering.block.GroupBlock

All Implemented Interfaces:

java.lang.Cloneable, Block

public class GroupBlock
extends AbstractBlock

Represents a grouping of blocks.

Since:

1.8.3

Version:

$Id: GroupBlock.java 33817 2011-01-05 14:11:52Z vmassol $

Nested Class Summary

Nested classes/interfaces inherited from interface org.xwiki.rendering.block.Block

Block.Axes

Constructor Summary

GroupBlock()
Create an empty group block with no children.

GroupBlock(java.util.List<Block> blocks)

GroupBlock(java.util.List<Block> blocks, java.util.Map<java.lang.String,java.lang.String> parameters)

GroupBlock(java.util.Map<java.lang.String,java.lang.String> parameters)
Create an empty group block with no children.

Method Summary

void	after(Listener listener) Send Listener events corresponding to the end of the block.
void	before(Listener listener) Send Listener events corresponding to the start of the block.

Methods inherited from class org.xwiki.rendering.block.AbstractBlock

addChild, addChildren, clone, clone, equals, getBlocks, getChildren, getChildrenByType, getFirstBlock, getNextSibling, getParameter, getParameters, getParent, getParentBlockByType, getPreviousBlockByType, getPreviousSibling, getRoot, hashCode, insertChildAfter, insertChildBefore, removeBlock, replaceChild, replaceChild, setChildren, setNextSiblingBlock, setParameter, setParameters, setParent, setPreviousSiblingBlock, traverse

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupBlock

public GroupBlock()

Create an empty group block with no children. This is useful when the user wants to call AbstractBlock.addChild(Block) manually for adding children one by one after the block is constructed.

GroupBlock

public GroupBlock(java.util.Map<java.lang.String,java.lang.String> parameters)

Create an empty group block with no children. This is useful when the user wants to call AbstractBlock.addChild(Block) manually for adding children one by one after the block is constructed.

Parameters:

parameters - the parameters of the group

GroupBlock

public GroupBlock(java.util.List<Block> blocks)

Parameters:

blocks - the children blocks of the group

GroupBlock

public GroupBlock(java.util.List<Block> blocks,
                  java.util.Map<java.lang.String,java.lang.String> parameters)

Parameters:

blocks - the children blocks of the group

parameters - the parameters of the group

Method Detail

before

public void before(Listener listener)

Send Listener events corresponding to the start of the block. For example for a Bold block, this allows an XHTML Listener (aka a Renderer) to output <b>.

Overrides:

before in class AbstractBlock

Parameters:

listener - the listener that will receive the events sent by this block before its children blocks have emitted their own events.

See Also:

AbstractBlock.before(org.xwiki.rendering.listener.Listener)

after

public void after(Listener listener)

Send Listener events corresponding to the end of the block. For example for a Bold block, this allows an XHTML Listener (aka a Renderer) to output </b>.

Overrides:

after in class AbstractBlock

Parameters:

listener - the listener that will receive the events sent by this block before its children blocks have emitted their own events.

See Also:

AbstractBlock.after(org.xwiki.rendering.listener.Listener)