org.xwiki.rendering.block
Class HeaderBlock

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

All Implemented Interfaces:

java.lang.Cloneable, Block

public class HeaderBlock
extends AbstractBlock

Since:

1.5M2

Version:

$Id: HeaderBlock.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

HeaderBlock(java.util.List<Block> childBlocks, HeaderLevel level)

HeaderBlock(java.util.List<Block> childBlocks, HeaderLevel level, java.util.Map<java.lang.String,java.lang.String> parameters)

HeaderBlock(java.util.List<Block> childBlocks, HeaderLevel level, java.util.Map<java.lang.String,java.lang.String> parameters, java.lang.String id)

HeaderBlock(java.util.List<Block> childBlocks, HeaderLevel level, java.lang.String id)

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.
java.lang.String	getId()
HeaderLevel	getLevel()
SectionBlock	getSection()

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

HeaderBlock

public HeaderBlock(java.util.List<Block> childBlocks,
                   HeaderLevel level)

Parameters:

childBlocks - the children of the header.

level - the level of the header

HeaderBlock

public HeaderBlock(java.util.List<Block> childBlocks,
                   HeaderLevel level,
                   java.util.Map<java.lang.String,java.lang.String> parameters)

Parameters:

childBlocks - the children of the header.

level - the level of the header

parameters - the parameters of the header

HeaderBlock

public HeaderBlock(java.util.List<Block> childBlocks,
                   HeaderLevel level,
                   java.lang.String id)

Parameters:

childBlocks - the children of the header.

level - the level of the header

id - the id of the header.

HeaderBlock

public HeaderBlock(java.util.List<Block> childBlocks,
                   HeaderLevel level,
                   java.util.Map<java.lang.String,java.lang.String> parameters,
                   java.lang.String id)

Parameters:

childBlocks - the children of the header.

level - the level of the header

parameters - the parameters of the header

id - the id of the header.

Method Detail

getLevel

public HeaderLevel getLevel()

Returns:

the level of the header

getId

public java.lang.String getId()

Returns:

the id of the header.

getSection

public SectionBlock getSection()

Returns:

the SectionBlock corresponding to this header

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)