org.xwiki.rendering.block
Class DefinitionListBlock

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

All Implemented Interfaces:

java.lang.Cloneable, Block, ListBLock

public class DefinitionListBlock
extends AbstractBlock
implements ListBLock

Represents a definition list. For example in HTML this is the equivalent of <dl>.

Since:

1.6M2

Version:

$Id$

Nested Class Summary

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

Block.Axes

Constructor Summary

DefinitionListBlock(java.util.List<Block> childrenBlocks)
Construct a Definition List block with no parameters.

DefinitionListBlock(java.util.List<Block> childrenBlocks, java.util.Map<java.lang.String,java.lang.String> parameters)
Construct a Definition List Block with parameters.

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

Methods inherited from interface org.xwiki.rendering.block.Block

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

Constructor Detail

DefinitionListBlock

public DefinitionListBlock(java.util.List<Block> childrenBlocks)

Construct a Definition List block with no parameters.

Parameters:

childrenBlocks - the blocks making the Definition list

DefinitionListBlock

public DefinitionListBlock(java.util.List<Block> childrenBlocks,
                           java.util.Map<java.lang.String,java.lang.String> parameters)

Construct a Definition List Block with parameters.

Parameters:

childrenBlocks - the blocks making the Definition list

parameters - see AbstractBlock.getParameter(String) for more details on parameters

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)