org.xwiki.rendering.wikimodel

Interface IWemListenerList

All Known Subinterfaces:

IWemListener

All Known Implementing Classes:

AgregatingWemListener, CompositeListener, EmptyWemListener, EventDumpListener, JspWikiSerializer, PrintInlineListener, PrintListener, PrintTextListener, XWikiSerializer, XWikiSerializer2

public interface IWemListenerList

This listener re-groups all hierarchical listener elements like lists (ordered and unordered), definition lists and quotations. This interface contains methods used to notify begin/end of each list as well as begin/end of each list item.

Since:

4.0M1

Version:

$Id: cc657f070f9d62d9e0253b65cf1f3d3c1fc5959c $

Method Summary

Modifier and Type	Method and Description
void	beginDefinitionDescription() This method is used to notify about a definition description.
void	beginDefinitionList(WikiParameters params) This method is used to notify about a new definition list.
void	beginDefinitionTerm() A definition term.
void	beginList(WikiParameters params, boolean ordered) This method is used to notify about a new list.
void	beginListItem() This method is used to notify about the beginning of a new item of a simple list (see beginList(WikiParameters, boolean)/ endList(WikiParameters, boolean) methods).
default void	beginListItem(WikiParameters params) This method is used to notify about the beginning of a new item of a simple list (see beginList(WikiParameters, boolean)/ endList(WikiParameters, boolean) methods).
void	beginQuotation(WikiParameters params) Notifies about the beginning of a quotation elements.
void	beginQuotationLine() A list containing quotation.
void	endDefinitionDescription() This method is used to notify about the end of a definition description.
void	endDefinitionList(WikiParameters params) This method is used to notify about the end of a definition list.
void	endDefinitionTerm() The end of a definition term.
void	endList(WikiParameters params, boolean ordered) This method is used to notify about the end of a list.
void	endListItem() This method is used to notify about the end of an item of a simple list (see beginList(WikiParameters, boolean)/ endList(WikiParameters, boolean) methods).
default void	endListItem(WikiParameters params) This method is used to notify about the end of an item of a simple list (see beginList(WikiParameters, boolean)/ endList(WikiParameters, boolean) methods).
void	endQuotation(WikiParameters params) Notifies about the end of a quotation element sequence.
void	endQuotationLine() This method is used to notify about the end of a quotation line.

Method Detail

beginDefinitionDescription

void beginDefinitionDescription()

This method is used to notify about a definition description. All definition descriptions are contained in definition lists and can contain text, embedded lists or an embedded document.

See Also:

endDefinitionDescription()

beginDefinitionList

void beginDefinitionList(WikiParameters params)

This method is used to notify about a new definition list.

Parameters:

params - list of parameters for the list

See Also:

endDefinitionList(WikiParameters)

beginDefinitionTerm

void beginDefinitionTerm()

A definition term. Definition terms can contain only formatted texts. Note that it is impossible to have an embedded list or a document inside of definition terms.

See Also:

endDefinitionTerm()

beginList

void beginList(WikiParameters params,
               boolean ordered)

This method is used to notify about a new list. Each list contain at least one list item. All list items are notified using the beginListItem()/endListItem() method pair. Items of lists of this type can contain the following sequence of elements:

1. formatted text - the text can be empty; in this case it is not notified
2. Just after the text the list item can have:
   • an embedded list - in this way it is possible to build hierarchical structures
   • an embedded document - it should be defined explicitly and it can have all valid elements of the top-level document

Parameters:

params - parameters of the list

ordered - if this flag is true then this method corresponds to a new ordered list ("ol"); otherwise this method notifies a beginning of an unordered list ("ul")

See Also:

endList(WikiParameters, boolean)

beginListItem

void beginListItem()

This method is used to notify about the beginning of a new item of a simple list (see beginList(WikiParameters, boolean)/ endList(WikiParameters, boolean) methods).

See Also:

endListItem()

beginListItem

default void beginListItem(WikiParameters params)

This method is used to notify about the beginning of a new item of a simple list (see beginList(WikiParameters, boolean)/ endList(WikiParameters, boolean) methods).

Since:

10.0

See Also:

endListItem(WikiParameters)

beginQuotation

void beginQuotation(WikiParameters params)

Notifies about the beginning of a quotation elements.

Parameters:

params - parameters of the list

See Also:

endQuotation(WikiParameters)

beginQuotationLine

void beginQuotationLine()

A list containing quotation. This is a part of quotation lists. Each quotation item can have other quotation lists.

See Also:

endQuotationLine()

endDefinitionDescription

void endDefinitionDescription()

This method is used to notify about the end of a definition description.

See Also:

beginDefinitionDescription()

endDefinitionList

void endDefinitionList(WikiParameters params)

This method is used to notify about the end of a definition list.

Parameters:

params - list of parameters for the list

See Also:

beginDefinitionList(WikiParameters)

endDefinitionTerm

void endDefinitionTerm()

The end of a definition term.

See Also:

beginDefinitionTerm()

endList

void endList(WikiParameters params,
             boolean ordered)

This method is used to notify about the end of a list.

Parameters:

params - parameters of the list

ordered - if this flag is true then this method corresponds to a new ordered list ("ol"); otherwise this method notifies a beginning of an unordered list ("ul")

See Also:

beginList(WikiParameters, boolean)

endListItem

void endListItem()

This method is used to notify about the end of an item of a simple list (see beginList(WikiParameters, boolean)/ endList(WikiParameters, boolean) methods).

See Also:

beginListItem()

endListItem

default void endListItem(WikiParameters params)

This method is used to notify about the end of an item of a simple list (see beginList(WikiParameters, boolean)/ endList(WikiParameters, boolean) methods).

Since:

10.0

See Also:

beginListItem(WikiParameters)

endQuotation

void endQuotation(WikiParameters params)

Notifies about the end of a quotation element sequence.

Parameters:

params - parameters of the list

See Also:

endQuotation(WikiParameters)

endQuotationLine

void endQuotationLine()

This method is used to notify about the end of a quotation line.

See Also:

endQuotationLine()