Package org.xwiki.rendering.wikimodel

Interface IWemListenerSemantic

All Known Subinterfaces:

IWemListener

All Known Implementing Classes:

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

public interface IWemListenerSemantic

This listener is used to notify about semantic elements defined in the document. Possible semantic elements are inline and block properties. Each block property can have a document or a simple paragraph as its value. Each inline element contains only formatted inline elements.

Since:

4.0M1

Version:

$Id: 177f363a08e881d7bf677e38d04e7db4c69199ef $

Method Summary

Modifier and Type	Method	Description
void	beginPropertyBlock(String propertyUri, boolean doc)	This method is called to notify about the beginning of a new property found in the parsed document.
void	beginPropertyInline(String propertyUri)	This method is called to notify about the beginning of a new inline property found in the text of the parsed document.
void	endPropertyBlock(String propertyUri, boolean doc)	This method is called to notify about the end of a block property found in the parsed document.
void	endPropertyInline(String propertyUri)	This method is called to notify about the end of an inline property found in the text of the parsed document.

Method Detail

beginPropertyBlock

void beginPropertyBlock(String propertyUri,
                        boolean doc)

This method is called to notify about the beginning of a new property found in the parsed document.

Parameters:

propertyUri - the URI of the semantic block property found in the document

doc - this flag is true if the found property contains a whole document; if this flag is false then expected property value contains a paragraph

beginPropertyInline

void beginPropertyInline(String propertyUri)

This method is called to notify about the beginning of a new inline property found in the text of the parsed document.

Parameters:

propertyUri - the URI of the semantic inline property found in the document

endPropertyBlock

void endPropertyBlock(String propertyUri,
                      boolean doc)

This method is called to notify about the end of a block property found in the parsed document.

Parameters:

propertyUri - the URI of the semantic block property found in the document

doc - this flag is true if the found property contains a whole document; otherwise (if this flag is false) the value of the property is a simple paragraph

endPropertyInline

void endPropertyInline(String propertyUri)

This method is called to notify about the end of an inline property found in the text of the parsed document.

Parameters:

propertyUri - the URI of the semantic inline property found in the document