org.xwiki.rendering.block
Class MetaDataBlock

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

All Implemented Interfaces:

Cloneable, Block

Direct Known Subclasses:

XDOM

public class MetaDataBlock
extends AbstractBlock

Represents any kind of MetaData in the XDOM (eg saving original blocks so that the XWiki Syntax Renderer can restore them after a transformation has been executed, source reference, etc).

Since:

3.0M2

Version:

$Id$

Nested Class Summary

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

Block.Axes

Constructor Summary

MetaDataBlock(List<Block> childBlocks)

MetaDataBlock(List<Block> childBlocks, MetaData metaData)

MetaDataBlock(List<Block> childBlocks, String key, Object value)
Helper constructor.

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.
MetaData	getMetaData()

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

MetaDataBlock

public MetaDataBlock(List<Block> childBlocks,
                     MetaData metaData)

Parameters:

childBlocks - the list of children blocks of the block to construct

metaData - the metadata to set

See Also:

AbstractBlock.AbstractBlock(List)

MetaDataBlock

public MetaDataBlock(List<Block> childBlocks,
                     String key,
                     Object value)

Helper constructor.

Parameters:

childBlocks - the list of children blocks of the block to construct

key - the metadata key to set

value - the metadata value to set

See Also:

AbstractBlock.AbstractBlock(List)

MetaDataBlock

public MetaDataBlock(List<Block> childBlocks)

Parameters:

childBlocks - the list of children blocks of the block to construct

See Also:

AbstractBlock.AbstractBlock(List)

Method Detail

getMetaData

public MetaData getMetaData()

Returns:

the metadata for this block, see MetaData

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)