org.xwiki.rendering.internal.renderer.xhtml
Class AnnotatedXHTMLRenderer

java.lang.Object
  org.xwiki.rendering.listener.chaining.AbstractChainingListener
      org.xwiki.rendering.renderer.AbstractChainingPrintRenderer
          org.xwiki.rendering.internal.renderer.xhtml.AnnotatedXHTMLRenderer

All Implemented Interfaces:

org.xwiki.component.phase.Initializable, ChainingListener, ImageListener, LinkListener, Listener, PrintRenderer, Renderer

@Component
@Named(value="annotatedxhtml/1.0")
@InstantiationStrategy(value=PER_LOOKUP)
public class AnnotatedXHTMLRenderer
extends AbstractChainingPrintRenderer
implements org.xwiki.component.phase.Initializable

Generates Annotated XHTML (ie XHTML containing metadata information, for example macro definition or link definition) from a XDOM object being traversed. The annotations allow initial source content to be fully reconstructed from the generated XHTML. This is required for example for doing round tripping between wiki syntax and XHTML syntax in the WYSIWYG editor.

Since:

2.0M3

Version:

$Id$

Field Summary

Fields inherited from interface org.xwiki.rendering.listener.Listener

EMPTY_PARAMETERS

Constructor Summary

AnnotatedXHTMLRenderer()

Method Summary

void	initialize()

Methods inherited from class org.xwiki.rendering.renderer.AbstractChainingPrintRenderer

getMainPrinter, getPrinter, popPrinter, pushPrinter, setPrinter

Methods inherited from class org.xwiki.rendering.listener.chaining.AbstractChainingListener

beginDefinitionDescription, beginDefinitionList, beginDefinitionTerm, beginDocument, beginFormat, beginGroup, beginHeader, beginLink, beginList, beginListItem, beginMacroMarker, beginMetaData, beginParagraph, beginQuotation, beginQuotationLine, beginSection, beginTable, beginTableCell, beginTableHeadCell, beginTableRow, endDefinitionDescription, endDefinitionList, endDefinitionTerm, endDocument, endFormat, endGroup, endHeader, endLink, endList, endListItem, endMacroMarker, endMetaData, endParagraph, endQuotation, endQuotationLine, endSection, endTable, endTableCell, endTableHeadCell, endTableRow, getListenerChain, onEmptyLines, onHorizontalLine, onId, onImage, onMacro, onNewLine, onRawText, onSpace, onSpecialSymbol, onVerbatim, onWord, setListenerChain

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.rendering.listener.Listener

beginDefinitionDescription, beginDefinitionList, beginDefinitionTerm, beginDocument, beginFormat, beginGroup, beginHeader, beginList, beginListItem, beginMacroMarker, beginMetaData, beginParagraph, beginQuotation, beginQuotationLine, beginSection, beginTable, beginTableCell, beginTableHeadCell, beginTableRow, endDefinitionDescription, endDefinitionList, endDefinitionTerm, endDocument, endFormat, endGroup, endHeader, endList, endListItem, endMacroMarker, endMetaData, endParagraph, endQuotation, endQuotationLine, endSection, endTable, endTableCell, endTableHeadCell, endTableRow, onEmptyLines, onHorizontalLine, onId, onMacro, onNewLine, onRawText, onSpace, onSpecialSymbol, onVerbatim, onWord

Methods inherited from interface org.xwiki.rendering.listener.LinkListener

beginLink, endLink

Methods inherited from interface org.xwiki.rendering.listener.ImageListener

onImage

Constructor Detail

AnnotatedXHTMLRenderer

public AnnotatedXHTMLRenderer()

Method Detail

initialize

public void initialize()
                throws org.xwiki.component.phase.InitializationException

Specified by:

initialize in interface org.xwiki.component.phase.Initializable

Throws:

org.xwiki.component.phase.InitializationException

Since:

2.0M3

See Also:

Initializable.initialize()