Package org.xwiki.rendering.wikimodel

Interface IWemListener

All Superinterfaces:

IWemListenerDocument, IWemListenerFigure, IWemListenerInline, IWemListenerList, IWemListenerProgramming, IWemListenerSemantic, IWemListenerSimpleBlocks, IWemListenerTable

All Known Implementing Classes:

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

public interface IWemListener
extends IWemListenerDocument, IWemListenerSimpleBlocks, IWemListenerInline, IWemListenerTable, IWemListenerList, IWemListenerSemantic, IWemListenerProgramming, IWemListenerFigure

This interface is a marker for classes implementing all WEM listeners. In the future it should be removed and replaced by an Object Adapter providing individual listeners. Such a provider should be used something like that:

 IWemListenerProvider provider = new MyWemListenerProvider();
 provider.registerListener(
      IWemListenerDocument.class,
      new MyDocumentListener());
 ...
 IWemListenerDocument docListener =
      provider.getListener(IWemListenerProvider.class);
 if (docListener != null) {
      docListener.beginDocument();
 }
 

Adapter-based approach is much more flexible and it can be used to transparently extend parsers to handle new types of structural elements.

Since:

4.0M1

Version:

$Id: e94a9b201bda5e847802da29bead677e11903d8c $

Method Summary

Methods inherited from interface org.xwiki.rendering.wikimodel.IWemListenerDocument

beginDocument, beginHeader, beginSection, beginSectionContent, endDocument, endHeader, endSection, endSectionContent

Methods inherited from interface org.xwiki.rendering.wikimodel.IWemListenerFigure

beginFigure, beginFigureCaption, endFigure, endFigureCaption

Methods inherited from interface org.xwiki.rendering.wikimodel.IWemListenerInline

beginFormat, endFormat, onEscape, onImage, onImage, onLineBreak, onNewLine, onReference, onReference, onSpace, onSpecialSymbol, onVerbatimInline, onWord

Methods inherited from interface org.xwiki.rendering.wikimodel.IWemListenerList

beginDefinitionDescription, beginDefinitionList, beginDefinitionTerm, beginList, beginListItem, beginListItem, beginQuotation, beginQuotationLine, endDefinitionDescription, endDefinitionList, endDefinitionTerm, endList, endListItem, endListItem, endQuotation, endQuotationLine

Methods inherited from interface org.xwiki.rendering.wikimodel.IWemListenerProgramming

onExtensionBlock, onExtensionInline, onMacroBlock, onMacroInline

Methods inherited from interface org.xwiki.rendering.wikimodel.IWemListenerSemantic

beginPropertyBlock, beginPropertyInline, endPropertyBlock, endPropertyInline

Methods inherited from interface org.xwiki.rendering.wikimodel.IWemListenerSimpleBlocks

beginInfoBlock, beginParagraph, endInfoBlock, endParagraph, onEmptyLines, onHorizontalLine, onVerbatimBlock

Methods inherited from interface org.xwiki.rendering.wikimodel.IWemListenerTable

beginTable, beginTableCell, beginTableRow, endTable, endTableCell, endTableRow, onTableCaption