Package org.xwiki.rendering.block

Class FigureBlock

java.lang.Object

org.xwiki.rendering.block.AbstractBlock

org.xwiki.rendering.block.FigureBlock

All Implemented Interfaces:

Cloneable, Block

public class FigureBlock
extends AbstractBlock

Tags the content as a figure (image(s), diagram, code fragment, audio, video, charts, etc). This is similar to the HTML5 <figure> element), with the ability to associate a caption to the figure.

Since:

10.2

Version:

$Id: ba194216ea48f29dd53b1e3cfceefca1e9d029ba $

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
FigureBlock(List<Block> blocks)
FigureBlock(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, get, getAttribute, getAttributes, getBlocks, getChildren, getFirstBlock, getNextSibling, getParameter, getParameters, getParent, getPreviousSibling, getRoot, getSyntaxMetadata, hashCode, 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

FigureBlock

public FigureBlock(List<Block> blocks)

Parameters:

blocks - the children blocks of the figure

FigureBlock

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

Parameters:

blocks - the children blocks of the figure

parameters - the parameters of the figure

Method Details

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.