Package org.xwiki.rendering.block

Class FigureCaptionBlock

java.lang.Object

org.xwiki.rendering.block.AbstractBlock

org.xwiki.rendering.block.FigureCaptionBlock

All Implemented Interfaces:

Cloneable, Block

public class FigureCaptionBlock
extends AbstractBlock

Represents a figure caption (similar to the HTML5 <figcaption> element). Needs to be a children of the FigureBlock block (either the first children block or the last children block).

Since:

10.2

Version:

$Id: 58fa11fdcebc519c757a703885fd80b81e3b485b $

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
FigureCaptionBlock(List<Block> blocks)
FigureCaptionBlock(List<Block> blocks, 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.

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

addChild, addChildren, clone, clone, equals, getBlocks, getChildren, getFirstBlock, getNextSibling, getParameter, getParameters, getParent, getPreviousSibling, getRoot, hashCode, indexOf, 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

FigureCaptionBlock

public FigureCaptionBlock(List<Block> blocks)

Parameters:

blocks - the children blocks of the figure caption

FigureCaptionBlock

public FigureCaptionBlock(List<Block> blocks,
                          Map<String,String> parameters)

Parameters:

blocks - the children blocks of the figure caption

parameters - the parameters of the figure caption

Method Detail

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.