org.xwiki.rendering.wikimodel

Interface IWemListenerSimpleBlocks

All Known Subinterfaces:

IWemListener

All Known Implementing Classes:

AgregatingWemListener, CompositeListener, ConfluenceExtendedWikiParser.EnhancedListener, EmptyWemListener, EventDumpListener, JspWikiSerializer, PrintInlineListener, PrintListener, PrintTextListener, TexSerializer, WemSimpleBlockTagNotifier, WemTagNotifier, XWikiSerializer, XWikiSerializer2

public interface IWemListenerSimpleBlocks

This listener re-groups methods used to notify about simple block elements. Each simple block element (like paragraphs) can not have other block elements or documents. Some of them can contain only formatted in-line elements.

Since:

4.0M1

Version:

$Id: 89e09a43237af2e9fdd787fa265c11416a9960bf $

Method Summary

Modifier and Type	Method and Description
void	beginInfoBlock(String infoType, WikiParameters params) This method is used to notify about the beginning of a "typed" paragraph.
void	beginParagraph(WikiParameters params) Begin of a simple paragraph.
void	endInfoBlock(String infoType, WikiParameters params) This method is used to notify about the end of a "typed" paragraph.
void	endParagraph(WikiParameters params) End of a simple paragraph.
void	onEmptyLines(int count) This method is used to notify about a sequence of empty lines.
void	onHorizontalLine(WikiParameters params) This method notifies horizontal lines defined in the text.
void	onVerbatimBlock(String str, WikiParameters params) This method notifies about a verbatim (pre-formatted) block defined in the text

Method Detail

beginInfoBlock

void beginInfoBlock(String infoType,
                    WikiParameters params)

This method is used to notify about the beginning of a "typed" paragraph. Some wiki syntaxes have special markups to define simple block elements corresponding to "warnings", "info blocks" and so on. Blocks of this type can have formatted inline elements.

Parameters:

infoType - the "type" of the special block

params - parameters of this block

See Also:

endInfoBlock(String, WikiParameters)

beginParagraph

void beginParagraph(WikiParameters params)

Begin of a simple paragraph. Paragraphs can contain only formatted inline elements.

Parameters:

params - paragraph parameters

See Also:

endParagraph(WikiParameters)

endInfoBlock

void endInfoBlock(String infoType,
                  WikiParameters params)

This method is used to notify about the end of a "typed" paragraph.

Parameters:

infoType - the "type" of the special block

params - parameters of this block

See Also:

beginInfoBlock(String, WikiParameters)

endParagraph

void endParagraph(WikiParameters params)

End of a simple paragraph.

Parameters:

params - paragraph parameters

See Also:

beginParagraph(WikiParameters)

onEmptyLines

void onEmptyLines(int count)

This method is used to notify about a sequence of empty lines. This event can be interpreted as an "empty paragraph".

Parameters:

count - the number of empty lines found in the text

onHorizontalLine

void onHorizontalLine(WikiParameters params)

This method notifies horizontal lines defined in the text.

Parameters:

params - parameters of the horizontal line

onVerbatimBlock

void onVerbatimBlock(String str,
                     WikiParameters params)

This method notifies about a verbatim (pre-formatted) block defined in the text

Parameters:

str - the content of the verbatim (pre-formatted) block

params - parameters of the verbatim block