Package 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.

For overviews, tutorials, examples, guides, and tool documentation, please see:

• Rendering Documentation

Since:

1.5M2

Interface Summary

Interface	Description
Block	Represents an element of a XWiki Document's content.
BlockFilter	Filter provided block into one or more block.
ListBLock	Represents any type of Lists (numbered list, bulleted list, etc).

Class Summary

Class	Description
AbstractBlock	Implementation for Block operations.
AbstractMacroBlock	Common class to MacroBlock and MacroMakerBlock.
BulletedListBlock	Represents a Bulleted list.
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.
DefinitionDescriptionBlock	Represents a definition description.
DefinitionListBlock	Represents a definition list.
DefinitionTermBlock	Represents a definition description.
EmptyLinesBlock	Represents an empty line between 2 standalone Blocks.
FigureBlock	Tags the content as a figure (image(s), diagram, code fragment, audio, video, charts, etc).
FigureCaptionBlock	Represents a figure caption (similar to the HTML5 <figcaption> element).
FormatBlock	Represents a text formatting block (bold, italic, etc).
GroupBlock	Represents a grouping of blocks.
HeaderBlock
HorizontalLineBlock	Represents a Horizontal line.
IdBlock	A reference/location in a page.
ImageBlock	Represents an image.
LinkBlock	Represents a Link element in a page.
ListItemBlock	Represents a List item element in a page.
MacroBlock	Represents a Macro (standalone or inline) defined in a page.
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.
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).
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).
NumberedListBlock	Represents a numbered List.
ParagraphBlock
PlainTextBlockFilter	Used to filter plain text blocks.
QuotationBlock	Represents a quotation.
QuotationLineBlock	Represents a quotation line.
RawBlock	Represents some raw content that shouldn't be parsed or modified and that should be injected as is in any output.
SectionBlock
SpaceBlock	A space block represents a space.
SpecialSymbolBlock	Represent a non-alphanumeric and non-space symbol (>, ], ...).
TableBlock	Represents a table.
TableCellBlock	Represents a cell of a table.
TableHeadCellBlock	Represents a head of a row or column of a table.
TableRowBlock	Represents the row of a table.
VerbatimBlock	A Verbatim block.
WordBlock	Represents a word.
XDOM	Contains the full tree of Block that represent a XWiki Document's content.

Enum Summary

Enum	Description
Block.Axes	Search axes used in searching methods.