org.xwiki.rendering.block
Class FormatBlock

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

All Implemented Interfaces:

java.lang.Cloneable, Block

public class FormatBlock
extends AbstractBlock

Represents a text formatting block (bold, italic, etc).

Since:

1.6M1

Version:

$Id$

Nested Class Summary

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

Block.Axes

Constructor Summary

FormatBlock(java.util.List<Block> childrenBlocks, Format format)

FormatBlock(java.util.List<Block> childrenBlocks, Format format, java.util.Map<java.lang.String,java.lang.String> 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.
Format	getFormat()

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

FormatBlock

public FormatBlock(java.util.List<Block> childrenBlocks,
                   Format format)

Parameters:

childrenBlocks - the nested children blocks

format - the formatting to apply to the children blocks

FormatBlock

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

Parameters:

childrenBlocks - the nested children blocks

format - the formatting to apply to the children blocks

parameters - the custom parameters

Method Detail

getFormat

public Format getFormat()

Returns:

the formatting to apply to the children blocks

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)