org.xwiki.rendering.wikimodel.xml

Class WemListTagNotifier

java.lang.Object

org.xwiki.rendering.wikimodel.xml.AbstractTagNotifier

org.xwiki.rendering.wikimodel.xml.WemListTagNotifier

All Implemented Interfaces:

IWemListenerList, ISaxConst

public class WemListTagNotifier
extends AbstractTagNotifier
implements IWemListenerList

Since:

4.0M1

Version:

$Id: c1e59476f66dbbc6798d87d9747ab32bd3647b60 $

Field Summary

Fields inherited from class org.xwiki.rendering.wikimodel.xml.AbstractTagNotifier

EMPTY_MAP, fListener

Fields inherited from interface org.xwiki.rendering.wikimodel.xml.ISaxConst

DEFINITION_DESCRIPTION, DEFINITION_LIST, DEFINITION_TERM, DOCUMENT, EMPTY_LINES, EMPTY_LINES_SIZE, ESCAPE, EXTENSION_BLOCK, EXTENSION_INLINE, EXTENSION_NAME, FORMAT, HEADER, HEADER_LEVEL, HORIZONTAL_LINE, IMAGE, IMAGE_IMPLICIT, INFO_BLOCK, INFO_BLOCK_TYPE, LINE_BREAK, LIST_ITEM, LIST_ORDERED, LIST_UNORDERED, MACRO_BLOCK, MACRO_INLINE, MACRO_NAME, NEW_LINE, PARAGRAPH, PROPERTY_BLOCK, PROPERTY_DOC, PROPERTY_INLINE, PROPERTY_URL, QUOTATION, QUOTATION_LINE, REF_EXPLICIT, REF_IMPLICIT, SECTION, SECTION_CONTENT, SECTION_DOC_LEVEL, SECTION_HEADER_LEVEL, SECTION_LEVEL, STYLES, TABLE, TABLE_CAPTION, TABLE_CAPTION_PARAM, TABLE_CELL, TABLE_HEAD, TABLE_ROW, VERBATIM_BLOCK, VERBATIM_INLINE

Constructor Summary

Constructors

Constructor and Description
WemListTagNotifier(ITagListener listener)

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 IWemListenerList.beginList(WikiParameters, boolean)/ IWemListenerList.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 IWemListenerList.beginList(WikiParameters, boolean)/ IWemListenerList.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.

Methods inherited from class org.xwiki.rendering.wikimodel.xml.AbstractTagNotifier

newParamMap, tagParams, tagParams, tagParams, tagParams, userParams, userParams, userParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WemListTagNotifier

public WemListTagNotifier(ITagListener listener)

Parameters:

listener -

Method Detail

beginDefinitionDescription

public void beginDefinitionDescription()

Description copied from interface: IWemListenerList

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.

Specified by:

beginDefinitionDescription in interface IWemListenerList

See Also:

IWemListenerList.endDefinitionDescription()

beginDefinitionList

public void beginDefinitionList(WikiParameters params)

Description copied from interface: IWemListenerList

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

Specified by:

beginDefinitionList in interface IWemListenerList

Parameters:

params - list of parameters for the list

See Also:

IWemListenerList.endDefinitionList(WikiParameters)

beginDefinitionTerm

public void beginDefinitionTerm()

Description copied from interface: IWemListenerList

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.

Specified by:

beginDefinitionTerm in interface IWemListenerList

See Also:

IWemListenerList.endDefinitionTerm()

beginList

public void beginList(WikiParameters params,
                      boolean ordered)

Description copied from interface: IWemListenerList

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 IWemListenerList.beginListItem()/IWemListenerList.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

Specified by:

beginList in interface IWemListenerList

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:

IWemListenerList.endList(WikiParameters, boolean)

beginListItem

public void beginListItem()

Description copied from interface: IWemListenerList

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

Specified by:

beginListItem in interface IWemListenerList

See Also:

IWemListenerList.endListItem()

beginQuotation

public void beginQuotation(WikiParameters params)

Description copied from interface: IWemListenerList

Notifies about the beginning of a quotation elements.

Specified by:

beginQuotation in interface IWemListenerList

Parameters:

params - parameters of the list

See Also:

IWemListenerList.endQuotation(WikiParameters)

beginQuotationLine

public void beginQuotationLine()

Description copied from interface: IWemListenerList

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

Specified by:

beginQuotationLine in interface IWemListenerList

See Also:

IWemListenerList.endQuotationLine()

endDefinitionDescription

public void endDefinitionDescription()

Description copied from interface: IWemListenerList

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

Specified by:

endDefinitionDescription in interface IWemListenerList

See Also:

IWemListenerList.beginDefinitionDescription()

endDefinitionList

public void endDefinitionList(WikiParameters params)

Description copied from interface: IWemListenerList

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

Specified by:

endDefinitionList in interface IWemListenerList

Parameters:

params - list of parameters for the list

See Also:

IWemListenerList.beginDefinitionList(WikiParameters)

endDefinitionTerm

public void endDefinitionTerm()

Description copied from interface: IWemListenerList

The end of a definition term.

Specified by:

endDefinitionTerm in interface IWemListenerList

See Also:

IWemListenerList.beginDefinitionTerm()

endList

public void endList(WikiParameters params,
                    boolean ordered)

Description copied from interface: IWemListenerList

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

Specified by:

endList in interface IWemListenerList

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:

IWemListenerList.beginList(WikiParameters, boolean)

endListItem

public void endListItem()

Description copied from interface: IWemListenerList

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

Specified by:

endListItem in interface IWemListenerList

See Also:

IWemListenerList.beginListItem()

endQuotation

public void endQuotation(WikiParameters params)

Description copied from interface: IWemListenerList

Notifies about the end of a quotation element sequence.

Specified by:

endQuotation in interface IWemListenerList

Parameters:

params - parameters of the list

See Also:

IWemListenerList.endQuotation(WikiParameters)

endQuotationLine

public void endQuotationLine()

Description copied from interface: IWemListenerList

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

Specified by:

endQuotationLine in interface IWemListenerList

See Also:

IWemListenerList.endQuotationLine()