Package org.xwiki.rendering.block

Class FormatBlock

java.lang.Object

org.xwiki.rendering.block.AbstractBlock

org.xwiki.rendering.block.FormatBlock

All Implemented Interfaces:

Cloneable, Block

public class FormatBlock
extends AbstractBlock

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

Since:

1.6M1

Version:

$Id: 55047ee4c63f71a4377affa51898a8eb26daa711 $

Nested Class Summary

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

Block.Axes

Field Summary

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

LIST_BLOCK_TYPE

Constructor Summary

Constructors

Constructor	Description
FormatBlock()	Create an empty format block with no children.
FormatBlock(List<Block> childrenBlocks, Format format)
FormatBlock(List<Block> childrenBlocks, Format format, Map<String,String> parameters)

Method Summary

Modifier and Type	Method	Description
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.
boolean	equals(Object obj)
Format	getFormat()
int	hashCode()

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

addChild, addChildren, clone, clone, get, getAttribute, getAttributes, getBlocks, getChildren, getFirstBlock, getNextSibling, getParameter, getParameters, getParent, getPreviousSibling, getRoot, getSyntaxMetadata, indexOf, insertChildAfter, insertChildBefore, removeBlock, replaceChild, replaceChild, setAttribute, setAttributes, setChildren, setNextSiblingBlock, setParameter, setParameters, setParent, setPreviousSiblingBlock, traverse

Methods inherited from class java.lang.Object

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

Constructor Details

FormatBlock

public FormatBlock()

Create an empty format 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.

FormatBlock

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

Parameters:

childrenBlocks - the nested children blocks

format - the formatting to apply to the children blocks

FormatBlock

public FormatBlock(List<Block> childrenBlocks,
 Format format,
 Map<String,String> parameters)

Parameters:

childrenBlocks - the nested children blocks

format - the formatting to apply to the children blocks

parameters - the custom parameters

Method Details

getFormat

public Format getFormat()

Returns:

the formatting to apply to the children blocks

before

public void before(Listener listener)

Description copied from class: AbstractBlock

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.

after

public void after(Listener listener)

Description copied from class: AbstractBlock

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.

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractBlock

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractBlock