Uses of Interface
org.xwiki.rendering.block.Block

Packages that use Block

Package	Description
org.xwiki.rendering.block	Represents content elements (Paragraph, Header, List, Styles, etc) as Blocks and a full document content is represented by a XDOM object.
org.xwiki.rendering.block.match
org.xwiki.rendering.renderer
org.xwiki.rendering.renderer.xml
org.xwiki.rendering.transformation
org.xwiki.rendering.util

Uses of Block in org.xwiki.rendering.block

Subinterfaces of Block in org.xwiki.rendering.block

Modifier and Type	Interface	Description
interface	ListBLock	Represents any type of Lists (numbered list, bulleted list, etc).

Classes in org.xwiki.rendering.block that implement Block

Modifier and Type	Class	Description
class	AbstractBlock	Implementation for Block operations.
class	AbstractMacroBlock	Common class to MacroBlock and MacroMakerBlock.
class	BulletedListBlock	Represents a Bulleted list.
class	CompositeBlock	This block itself does not have any meaning (it does not have any corresponding rendering stream event) and is just here to pass together several Blocks to a method or as a return value as a Block.
class	DefinitionDescriptionBlock	Represents a definition description.
class	DefinitionListBlock	Represents a definition list.
class	DefinitionTermBlock	Represents a definition description.
class	EmptyLinesBlock	Represents an empty line between 2 standalone Blocks.
class	FigureBlock	Tags the content as a figure (image(s), diagram, code fragment, audio, video, charts, etc).
class	FigureCaptionBlock	Represents a figure caption (similar to the HTML5 <figcaption> element).
class	FormatBlock	Represents a text formatting block (bold, italic, etc).
class	GroupBlock	Represents a grouping of blocks.
class	HeaderBlock
class	HorizontalLineBlock	Represents a Horizontal line.
class	IdBlock	A reference/location in a page.
class	ImageBlock	Represents an image.
class	LinkBlock	Represents a Link element in a page.
class	ListItemBlock	Represents a List item element in a page.
class	MacroBlock	Represents a Macro (standalone or inline) defined in a page.
class	MacroMarkerBlock	A special block that Macro Blocks generate when they are executed so that it's possible to reconstruct the initial syntax even after Macros have been executed.
class	MetaDataBlock	Represents any kind of MetaData in the XDOM (eg saving original blocks so that the XWiki Syntax Renderer can restore them after a transformation has been executed, source reference, etc).
final class	NewLineBlock	Represents a new line or line break (it's up to the Renderers to decide if it should be outputted as a new line or as a line break in the given syntax).
class	NumberedListBlock	Represents a numbered List.
class	ParagraphBlock
class	QuotationBlock	Represents a quotation.
class	QuotationLineBlock	Represents a quotation line.
class	RawBlock	Represents some raw content that shouldn't be parsed or modified and that should be injected as is in any output.
class	SectionBlock
final class	SpaceBlock	A space block represents a space.
class	SpecialSymbolBlock	Represent a non-alphanumeric and non-space symbol (>, ], ...).
class	TableBlock	Represents a table.
class	TableCellBlock	Represents a cell of a table.
class	TableHeadCellBlock	Represents a head of a row or column of a table.
class	TableRowBlock	Represents the row of a table.
class	VerbatimBlock	A Verbatim block.
class	WordBlock	Represents a word.
class	XDOM	Contains the full tree of Block that represent a XWiki Document's content.

Methods in org.xwiki.rendering.block with type parameters of type Block

Modifier and Type	Method	Description
<T extends Block> List<T>	AbstractBlock.getBlocks(BlockMatcher matcher, Block.Axes axes)
<T extends Block> List<T>	Block.getBlocks(BlockMatcher matcher, Block.Axes axes)	Get all blocks following provided BlockMatcher and Block.Axes.
<T extends Block> T	AbstractBlock.getFirstBlock(BlockMatcher matcher, Block.Axes axes)
<T extends Block> T	Block.getFirstBlock(BlockMatcher matcher, Block.Axes axes)	Get the first matched block in the provided Block.Axes.

Methods in org.xwiki.rendering.block that return Block

Modifier and Type	Method	Description
Block	AbstractBlock.clone()
Block	AbstractBlock.clone(BlockFilter blockFilter)	Return a copy of the block with filtered children.
Block	Block.clone()
Block	Block.clone(BlockFilter blockFilter)	Return a copy of the block with filtered children.
Block	AbstractBlock.getNextSibling()
Block	Block.getNextSibling()
Block	AbstractBlock.getParent()
Block	Block.getParent()	Get the parent block.
Block	AbstractBlock.getPreviousSibling()
Block	Block.getPreviousSibling()
Block	AbstractBlock.getRoot()
Block	Block.getRoot()	Gets the top level Block.

Methods in org.xwiki.rendering.block that return types with arguments of type Block

Modifier and Type	Method	Description
List<Block>	BlockFilter.filter(Block block)	Filter provided block into zero or more block.
List<Block>	PlainTextBlockFilter.filter(Block block)
List<Block>	AbstractBlock.getChildren()
List<Block>	Block.getChildren()	Gets all children blocks.

Methods in org.xwiki.rendering.block with parameters of type Block

Modifier and Type	Method	Description
void	AbstractBlock.addChild(Block blockToAdd)
void	Block.addChild(Block blockToAdd)	Helper method to add a single child block to the end of the children list of the current block.
List<Block>	BlockFilter.filter(Block block)	Filter provided block into zero or more block.
List<Block>	PlainTextBlockFilter.filter(Block block)
long	AbstractBlock.indexOf(Block child)	Find the index of the block in the tree.
void	AbstractBlock.insertChildAfter(Block blockToInsert, Block previousBlock)
void	Block.insertChildAfter(Block blockToInsert, Block previousBlock)	Helper method to add a single child block to the current block after the provided existing child block.
void	AbstractBlock.insertChildBefore(Block blockToInsert, Block nextBlock)
void	Block.insertChildBefore(Block blockToInsert, Block nextBlock)	Helper method to add a single child block to the current block before the provided existing child block.
void	AbstractBlock.removeBlock(Block childBlockToRemove)
void	Block.removeBlock(Block childBlockToRemove)	Removes a Block.
void	AbstractBlock.replaceChild(List<Block> newBlocks, Block oldBlock)
void	AbstractBlock.replaceChild(Block newBlock, Block oldBlock)
void	Block.replaceChild(List<Block> newBlocks, Block oldBlock)	Replaces an existing children block with the passed new blocks.
void	Block.replaceChild(Block newBlock, Block oldBlock)	Replaces an existing children block with the passed new block.
void	AbstractBlock.setNextSiblingBlock(Block nextSiblingBlock)
void	Block.setNextSiblingBlock(Block nextSiblingBlock)
void	AbstractBlock.setParent(Block parentBlock)
void	Block.setParent(Block parentBlock)	Sets the parent block.
void	AbstractBlock.setPreviousSiblingBlock(Block previousSiblingBlock)
void	Block.setPreviousSiblingBlock(Block previousSiblingBlock)

Method parameters in org.xwiki.rendering.block with type arguments of type Block

Modifier and Type	Method	Description
void	AbstractBlock.addChildren(List<? extends Block> blocksToAdd)
void	Block.addChildren(List<? extends Block> blocksToAdd)	Adds several children blocks to the end of the children list of the current block.
<T> Optional<T>	AbstractBlock.get(Function<Block,Optional<T>> searcher, Block.Axes axes)
default <T> Optional<T>	Block.get(Function<Block,Optional<T>> searcher, Block.Axes axes)	Get the first value extracted from the blocks in the provided Block.Axes.
void	AbstractBlock.replaceChild(List<Block> newBlocks, Block oldBlock)
void	Block.replaceChild(List<Block> newBlocks, Block oldBlock)	Replaces an existing children block with the passed new blocks.
void	AbstractBlock.setChildren(List<? extends Block> children)
void	Block.setChildren(List<? extends Block> children)	Replace current children by the provided list of Blocks.

Constructors in org.xwiki.rendering.block with parameters of type Block

Modifier	Constructor	Description
	AbstractBlock(Block childBlock)	Constructs a block with a child block.
	AbstractBlock(Block childBlock, Map<String,String> parameters)	Construct a block with a child block and parameters.

Constructor parameters in org.xwiki.rendering.block with type arguments of type Block

Modifier	Constructor	Description
	AbstractBlock(List<? extends Block> childrenBlocks)	Constructs a block with children blocks.
	AbstractBlock(List<? extends Block> childrenBlocks, Map<String,String> parameters)	Construct a block with children blocks and parameters.
	AbstractMacroBlock(List<? extends Block> childrenBlocks, Map<String,String> parameters, String id, String content, boolean inline)
	BulletedListBlock(List<Block> childrenBlocks)	Construct a Bulleted List Block with no parameters.
	BulletedListBlock(List<Block> childrenBlocks, Map<String,String> parameters)	Construct a Bulleted List Block with parameters.
	CompositeBlock(List<Block> blocks)
	DefinitionDescriptionBlock(List<Block> childrenBlocks)	Construct a Definition Description block.
	DefinitionListBlock(List<Block> childrenBlocks)	Construct a Definition List block with no parameters.
	DefinitionListBlock(List<Block> childrenBlocks, Map<String,String> parameters)	Construct a Definition List Block with parameters.
	DefinitionTermBlock(List<Block> childrenBlocks)	Construct a Definition Term block.
	FigureBlock(List<Block> blocks)
	FigureBlock(List<Block> blocks, Map<String,String> parameters)
	FigureCaptionBlock(List<Block> blocks)
	FigureCaptionBlock(List<Block> blocks, Map<String,String> parameters)
	FormatBlock(List<Block> childrenBlocks, Format format)
	FormatBlock(List<Block> childrenBlocks, Format format, Map<String,String> parameters)
	GroupBlock(List<Block> blocks)
	GroupBlock(List<Block> blocks, Map<String,String> parameters)
	HeaderBlock(List<Block> childBlocks, HeaderLevel level)
	HeaderBlock(List<Block> childBlocks, HeaderLevel level, String id)
	HeaderBlock(List<Block> childBlocks, HeaderLevel level, Map<String,String> parameters)
	HeaderBlock(List<Block> childBlocks, HeaderLevel level, Map<String,String> parameters, String id)
	LinkBlock(List<Block> childrenBlocks, ResourceReference reference, boolean freestanding)
	LinkBlock(List<Block> childrenBlocks, ResourceReference reference, boolean freestanding, Map<String,String> parameters)
	ListItemBlock(List<Block> childrenBlocks)	Constructs a list item Block.
	ListItemBlock(List<Block> childrenBlocks, Map<String,String> parameters)	Constructs a list item Block.
	MacroMarkerBlock(String id, Map<String,String> parameters, String content, List<Block> childBlocks, boolean inline)
	MacroMarkerBlock(String id, Map<String,String> parameters, List<Block> childBlocks, boolean isInline)
	MetaDataBlock(List<? extends Block> childBlocks)
	MetaDataBlock(List<? extends Block> childBlocks, String key, Object value)	Helper constructor.
	MetaDataBlock(List<? extends Block> childBlocks, MetaData metaData)
	NumberedListBlock(List<Block> childrenBlocks)	Construct a Numbered List Block with no parameters.
	NumberedListBlock(List<Block> childrenBlocks, Map<String,String> parameters)	Construct a Numbered List Block with parameters.
	ParagraphBlock(List<Block> blocks)
	ParagraphBlock(List<Block> blocks, Map<String,String> parameters)
	QuotationBlock(List<Block> blocks)
	QuotationBlock(List<Block> blocks, Map<String,String> parameters)
	QuotationLineBlock(List<Block> blocks)
	SectionBlock(List<Block> childBlocks)
	SectionBlock(List<Block> childBlocks, Map<String,String> parameters)
	TableBlock(List<Block> list)
	TableBlock(List<Block> list, Map<String,String> parameters)
	TableCellBlock(List<Block> list)
	TableCellBlock(List<Block> list, Map<String,String> parameters)
	TableHeadCellBlock(List<Block> list)
	TableHeadCellBlock(List<Block> list, Map<String,String> parameters)
	TableRowBlock(List<Block> list)
	TableRowBlock(List<Block> list, Map<String,String> parameters)
	XDOM(List<? extends Block> childBlocks)
	XDOM(List<? extends Block> childBlocks, MetaData metaData)
	XDOM(List<? extends Block> childBlocks, IdGenerator idGenerator)
	XDOM(List<? extends Block> childBlocks, IdGenerator idGenerator, MetaData metaData)

Uses of Block in org.xwiki.rendering.block.match

Methods in org.xwiki.rendering.block.match with type parameters of type Block

Modifier and Type	Method	Description
<T extends Block> List<T>	BlockNavigator.getBlocks(Block currentBlock, Block.Axes currentAxes)	Get all blocks following provided BlockMatcher and Block.Axes.
<T extends Block> T	BlockNavigator.getFirstBlock(Block currentBlock, Block.Axes currentAxes)	Get the first matched block in the provided Block.Axes.

Methods in org.xwiki.rendering.block.match with parameters of type Block

Modifier and Type	Method	Description
<T extends Block> List<T>	BlockNavigator.getBlocks(Block currentBlock, Block.Axes currentAxes)	Get all blocks following provided BlockMatcher and Block.Axes.
<T extends Block> T	BlockNavigator.getFirstBlock(Block currentBlock, Block.Axes currentAxes)	Get the first matched block in the provided Block.Axes.
boolean	AnyBlockMatcher.match(Block block)
boolean	BlockMatcher.match(Block block)	True if the provided block is matched.
boolean	ClassBlockMatcher.match(Block block)
boolean	CompositeBlockMatcher.match(Block block)
boolean	CounterBlockMatcher.match(Block block)
boolean	EqualsBlockMatcher.match(Block block)
boolean	FunctionBlockMatcher.match(Block block)
boolean	MacroBlockMatcher.match(Block block)
boolean	MacroMarkerBlockMatcher.match(Block block)
boolean	MetadataBlockMatcher.match(Block block)
boolean	OrBlockMatcher.match(Block block)
boolean	SameBlockMatcher.match(Block block)

Constructors in org.xwiki.rendering.block.match with parameters of type Block

Modifier	Constructor	Description
	CounterBlockMatcher(Block stopBlock)	Find the index of the passed block.
	EqualsBlockMatcher(Block block)
	SameBlockMatcher(Block block)

Constructor parameters in org.xwiki.rendering.block.match with type arguments of type Block

Modifier	Constructor	Description
	ClassBlockMatcher(Class<? extends Block> blockClass)
	FunctionBlockMatcher(Function<Block,Optional<T>> function)

Uses of Block in org.xwiki.rendering.renderer

Methods in org.xwiki.rendering.renderer with parameters of type Block

Modifier and Type	Method	Description
void	BlockRenderer.render(Block block, WikiPrinter printer)

Method parameters in org.xwiki.rendering.renderer with type arguments of type Block

Modifier and Type	Method	Description
void	BlockRenderer.render(Collection<Block> blocks, WikiPrinter printer)

Uses of Block in org.xwiki.rendering.renderer.xml

Methods in org.xwiki.rendering.renderer.xml with parameters of type Block

Modifier and Type	Method	Description
void	ContentHandlerBlockRenderer.render(Block block, ContentHandler contentHandler)

Method parameters in org.xwiki.rendering.renderer.xml with type arguments of type Block

Modifier and Type	Method	Description
void	ContentHandlerBlockRenderer.render(Collection<Block> blocks, ContentHandler contentHandler)

Uses of Block in org.xwiki.rendering.transformation

Methods in org.xwiki.rendering.transformation that return Block

Modifier and Type	Method	Description
Block	RenderingContext.getCurrentBlock()

Methods in org.xwiki.rendering.transformation with parameters of type Block

Modifier and Type	Method	Description
void	TransformationManager.performTransformations(Block block, TransformationContext context)
default void	Transformation.prepare(Block block)	Prepare a block meant to be cached to be executed several times.
void	Transformation.transform(Block block, TransformationContext context)	Transform the passed XDOM and modifies it.

Uses of Block in org.xwiki.rendering.util

Methods in org.xwiki.rendering.util that return Block

Modifier and Type	Method	Description
Block	ParserUtils.convertToInline(Block rootBlock, boolean preserveXDOM)	Make its best to convert a passed block to its inline version.

Methods in org.xwiki.rendering.util that return types with arguments of type Block

Modifier and Type	Method	Description
default List<Block>	ErrorBlockGenerator.generateErrorBlocks(boolean inline, String messageId, String defaultMessage, String defaultDescription, Object... arguments)	Generates error blocks to render an error in a wiki page.
List<Block>	ErrorBlockGenerator.generateErrorBlocks(String message, String description, boolean isInline)	Deprecated. since 14.0RC1, use ErrorBlockGenerator.generateErrorBlocks(boolean, String, String, String, Object...) instead
List<Block>	ErrorBlockGenerator.generateErrorBlocks(String messagePrefix, Throwable throwable, boolean isInline)	Deprecated. since 14.0RC1, use ErrorBlockGenerator.generateErrorBlocks(boolean, String, String, String, Object...) instead

Methods in org.xwiki.rendering.util with parameters of type Block

Modifier and Type	Method	Description
default boolean	ErrorBlockGenerator.containsError(Block block)
Block	ParserUtils.convertToInline(Block rootBlock, boolean preserveXDOM)	Make its best to convert a passed block to its inline version.

Method parameters in org.xwiki.rendering.util with type arguments of type Block

Modifier and Type	Method	Description
void	ParserUtils.convertToInline(List<Block> blocks)	Make its best to convert a passed blocks to their inline version.
void	ParserUtils.removeTopLevelParagraph(List<Block> blocks)	Removes any top level paragraph since for example for the following use case we don't want an extra paragraph block: = hello {{velocity}}world{{/velocity}}.