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

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

All Implemented Interfaces:

ChainingListener, ImageListener, LinkListener, Listener, PrintRenderer, Renderer

Direct Known Subclasses:

AnnotatedXHTMLChainingRenderer

public class XHTMLChainingRenderer
extends AbstractChainingPrintRenderer

Convert listener events to XHTML.

Since:

1.8RC1

Version:

$Id$

Field Summary

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

EMPTY_PARAMETERS

Constructor Summary

XHTMLChainingRenderer(XHTMLLinkRenderer linkRenderer, XHTMLImageRenderer imageRenderer, ListenerChain listenerChain)

Method Summary

void	beginDefinitionDescription()
void	beginDefinitionList(java.util.Map<java.lang.String,java.lang.String> parameters)
void	beginDefinitionTerm()
void	beginFormat(Format format, java.util.Map<java.lang.String,java.lang.String> parameters)
void	beginGroup(java.util.Map<java.lang.String,java.lang.String> parameters)
void	beginHeader(HeaderLevel level, java.lang.String id, java.util.Map<java.lang.String,java.lang.String> parameters)
void	beginLink(ResourceReference reference, boolean isFreeStandingURI, java.util.Map<java.lang.String,java.lang.String> parameters)
void	beginList(ListType listType, java.util.Map<java.lang.String,java.lang.String> parameters)
void	beginListItem()
void	beginParagraph(java.util.Map<java.lang.String,java.lang.String> parameters)
void	beginQuotation(java.util.Map<java.lang.String,java.lang.String> parameters)
void	beginQuotationLine()
void	beginTable(java.util.Map<java.lang.String,java.lang.String> parameters)
void	beginTableCell(java.util.Map<java.lang.String,java.lang.String> parameters)
void	beginTableHeadCell(java.util.Map<java.lang.String,java.lang.String> parameters)
void	beginTableRow(java.util.Map<java.lang.String,java.lang.String> parameters)
void	endDefinitionDescription()
void	endDefinitionList(java.util.Map<java.lang.String,java.lang.String> parameters)
void	endDefinitionTerm()
void	endFormat(Format format, java.util.Map<java.lang.String,java.lang.String> parameters)
void	endGroup(java.util.Map<java.lang.String,java.lang.String> parameters)
void	endHeader(HeaderLevel level, java.lang.String id, java.util.Map<java.lang.String,java.lang.String> parameters)
void	endLink(ResourceReference reference, boolean isFreeStandingURI, java.util.Map<java.lang.String,java.lang.String> parameters)
void	endList(ListType listType, java.util.Map<java.lang.String,java.lang.String> parameters)
void	endListItem()
void	endParagraph(java.util.Map<java.lang.String,java.lang.String> parameters)
void	endQuotation(java.util.Map<java.lang.String,java.lang.String> parameters)
void	endTable(java.util.Map<java.lang.String,java.lang.String> parameters)
void	endTableCell(java.util.Map<java.lang.String,java.lang.String> parameters)
void	endTableHeadCell(java.util.Map<java.lang.String,java.lang.String> parameters)
void	endTableRow(java.util.Map<java.lang.String,java.lang.String> parameters)
protected BlockStateChainingListener	getBlockState()
protected EmptyBlockChainingListener	getEmptyBlockState()
protected MetaDataStateChainingListener	getMetaDataState()
protected XHTMLWikiPrinter	getXHTMLWikiPrinter()
void	onEmptyLines(int count)
void	onHorizontalLine(java.util.Map<java.lang.String,java.lang.String> parameters)
void	onId(java.lang.String name)
void	onImage(ResourceReference reference, boolean isFreeStandingURI, java.util.Map<java.lang.String,java.lang.String> parameters)
void	onNewLine()
void	onRawText(java.lang.String text, Syntax syntax)
void	onSpace()
void	onSpecialSymbol(char symbol)
void	onVerbatim(java.lang.String protectedString, boolean isInline, java.util.Map<java.lang.String,java.lang.String> parameters)
void	onWord(java.lang.String word)
protected void	popPrinter()
protected void	pushPrinter(WikiPrinter wikiPrinter)

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

getMainPrinter, getPrinter, setPrinter

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

beginDocument, beginMacroMarker, beginMetaData, beginSection, endDocument, endMacroMarker, endMetaData, endQuotationLine, endSection, getListenerChain, onMacro, 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

beginDocument, beginMacroMarker, beginMetaData, beginSection, endDocument, endMacroMarker, endMetaData, endQuotationLine, endSection, onMacro

Constructor Detail

XHTMLChainingRenderer

public XHTMLChainingRenderer(XHTMLLinkRenderer linkRenderer,
                             XHTMLImageRenderer imageRenderer,
                             ListenerChain listenerChain)

Parameters:

linkRenderer - the object to render link events into XHTML. This is done so that it's pluggable because link rendering depends on how the underlying system wants to handle it. For example for XWiki we check if the document exists, we get the document URL, etc.

imageRenderer - the object to render image events into XHTML. This is done so that it's pluggable because image rendering depends on how the underlying system wants to handle it. For example for XWiki we check if the image exists as a document attachments, we get its URL, etc.

listenerChain - the chain of listener filters used to compute various states

Method Detail

getBlockState

protected BlockStateChainingListener getBlockState()

getEmptyBlockState

protected EmptyBlockChainingListener getEmptyBlockState()

getMetaDataState

protected MetaDataStateChainingListener getMetaDataState()

pushPrinter

protected void pushPrinter(WikiPrinter wikiPrinter)

Overrides:

pushPrinter in class AbstractChainingPrintRenderer

See Also:

AbstractChainingPrintRenderer.pushPrinter(org.xwiki.rendering.renderer.printer.WikiPrinter)

popPrinter

protected void popPrinter()

Overrides:

popPrinter in class AbstractChainingPrintRenderer

See Also:

AbstractChainingPrintRenderer.popPrinter()

getXHTMLWikiPrinter

protected XHTMLWikiPrinter getXHTMLWikiPrinter()

beginGroup

public void beginGroup(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

beginGroup in interface Listener

Overrides:

beginGroup in class AbstractChainingListener

See Also:

AbstractChainingListener.beginGroup(Map)

endGroup

public void endGroup(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

endGroup in interface Listener

Overrides:

endGroup in class AbstractChainingListener

See Also:

AbstractChainingListener.endGroup(Map)

beginFormat

public void beginFormat(Format format,
                        java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

beginFormat in interface Listener

Overrides:

beginFormat in class AbstractChainingListener

See Also:

AbstractChainingListener.beginFormat(Format, java.util.Map)

endFormat

public void endFormat(Format format,
                      java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

endFormat in interface Listener

Overrides:

endFormat in class AbstractChainingListener

See Also:

AbstractChainingListener.endFormat(Format, Map)

beginParagraph

public void beginParagraph(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

beginParagraph in interface Listener

Overrides:

beginParagraph in class AbstractChainingListener

See Also:

AbstractChainingListener.beginParagraph(java.util.Map)

endParagraph

public void endParagraph(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

endParagraph in interface Listener

Overrides:

endParagraph in class AbstractChainingListener

See Also:

AbstractChainingListener.endParagraph(java.util.Map)

onNewLine

public void onNewLine()

Specified by:

onNewLine in interface Listener

Overrides:

onNewLine in class AbstractChainingListener

See Also:

AbstractChainingListener.onNewLine()

beginLink

public void beginLink(ResourceReference reference,
                      boolean isFreeStandingURI,
                      java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

beginLink in interface LinkListener

Overrides:

beginLink in class AbstractChainingListener

See Also:

AbstractChainingListener.beginLink(org.xwiki.rendering.listener.reference.ResourceReference , boolean, Map)

endLink

public void endLink(ResourceReference reference,
                    boolean isFreeStandingURI,
                    java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

endLink in interface LinkListener

Overrides:

endLink in class AbstractChainingListener

See Also:

AbstractChainingListener.endLink(org.xwiki.rendering.listener.reference.ResourceReference , boolean, Map)

beginHeader

public void beginHeader(HeaderLevel level,
                        java.lang.String id,
                        java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

beginHeader in interface Listener

Overrides:

beginHeader in class AbstractChainingListener

See Also:

AbstractChainingListener.beginHeader(HeaderLevel, String, Map)

endHeader

public void endHeader(HeaderLevel level,
                      java.lang.String id,
                      java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

endHeader in interface Listener

Overrides:

endHeader in class AbstractChainingListener

See Also:

AbstractChainingListener.endHeader(HeaderLevel, String, Map)

onWord

public void onWord(java.lang.String word)

Specified by:

onWord in interface Listener

Overrides:

onWord in class AbstractChainingListener

See Also:

AbstractChainingListener.onWord(String)

onSpace

public void onSpace()

Specified by:

onSpace in interface Listener

Overrides:

onSpace in class AbstractChainingListener

See Also:

AbstractChainingListener.onSpace()

onSpecialSymbol

public void onSpecialSymbol(char symbol)

Specified by:

onSpecialSymbol in interface Listener

Overrides:

onSpecialSymbol in class AbstractChainingListener

See Also:

AbstractChainingListener.onSpecialSymbol(char)

beginList

public void beginList(ListType listType,
                      java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

beginList in interface Listener

Overrides:

beginList in class AbstractChainingListener

See Also:

AbstractChainingListener.beginList(org.xwiki.rendering.listener.ListType, java.util.Map)

beginListItem

public void beginListItem()

Specified by:

beginListItem in interface Listener

Overrides:

beginListItem in class AbstractChainingListener

See Also:

AbstractChainingListener.beginListItem()

endList

public void endList(ListType listType,
                    java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

endList in interface Listener

Overrides:

endList in class AbstractChainingListener

See Also:

AbstractChainingListener.endList(org.xwiki.rendering.listener.ListType, java.util.Map)

endListItem

public void endListItem()

Specified by:

endListItem in interface Listener

Overrides:

endListItem in class AbstractChainingListener

See Also:

AbstractChainingListener.endListItem()

onId

public void onId(java.lang.String name)

Specified by:

onId in interface Listener

Overrides:

onId in class AbstractChainingListener

See Also:

AbstractChainingListener.onId(String)

onHorizontalLine

public void onHorizontalLine(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

onHorizontalLine in interface Listener

Overrides:

onHorizontalLine in class AbstractChainingListener

See Also:

AbstractChainingListener.onHorizontalLine(Map)

onVerbatim

public void onVerbatim(java.lang.String protectedString,
                       boolean isInline,
                       java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

onVerbatim in interface Listener

Overrides:

onVerbatim in class AbstractChainingListener

See Also:

AbstractChainingListener.onVerbatim(String, boolean, Map)

onEmptyLines

public void onEmptyLines(int count)

Specified by:

onEmptyLines in interface Listener

Overrides:

onEmptyLines in class AbstractChainingListener

See Also:

AbstractChainingListener.onEmptyLines(int)

beginDefinitionList

public void beginDefinitionList(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

beginDefinitionList in interface Listener

Overrides:

beginDefinitionList in class AbstractChainingListener

Since:

2.0RC1

See Also:

AbstractChainingListener.beginDefinitionList(java.util.Map)

endDefinitionList

public void endDefinitionList(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

endDefinitionList in interface Listener

Overrides:

endDefinitionList in class AbstractChainingListener

Since:

2.0RC1

See Also:

AbstractChainingListener.endDefinitionList(java.util.Map)

beginDefinitionTerm

public void beginDefinitionTerm()

Specified by:

beginDefinitionTerm in interface Listener

Overrides:

beginDefinitionTerm in class AbstractChainingListener

See Also:

AbstractChainingListener.beginDefinitionTerm()

beginDefinitionDescription

public void beginDefinitionDescription()

Specified by:

beginDefinitionDescription in interface Listener

Overrides:

beginDefinitionDescription in class AbstractChainingListener

See Also:

AbstractChainingListener.beginDefinitionDescription()

endDefinitionTerm

public void endDefinitionTerm()

Specified by:

endDefinitionTerm in interface Listener

Overrides:

endDefinitionTerm in class AbstractChainingListener

See Also:

AbstractChainingListener.endDefinitionTerm()

endDefinitionDescription

public void endDefinitionDescription()

Specified by:

endDefinitionDescription in interface Listener

Overrides:

endDefinitionDescription in class AbstractChainingListener

See Also:

AbstractChainingListener.endDefinitionDescription()

beginQuotation

public void beginQuotation(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

beginQuotation in interface Listener

Overrides:

beginQuotation in class AbstractChainingListener

See Also:

AbstractChainingListener.beginQuotation(java.util.Map)

endQuotation

public void endQuotation(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

endQuotation in interface Listener

Overrides:

endQuotation in class AbstractChainingListener

See Also:

AbstractChainingListener.endQuotation(java.util.Map)

beginQuotationLine

public void beginQuotationLine()

Specified by:

beginQuotationLine in interface Listener

Overrides:

beginQuotationLine in class AbstractChainingListener

See Also:

AbstractChainingListener.beginQuotationLine()

beginTable

public void beginTable(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

beginTable in interface Listener

Overrides:

beginTable in class AbstractChainingListener

See Also:

AbstractChainingListener.beginTable(java.util.Map)

beginTableRow

public void beginTableRow(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

beginTableRow in interface Listener

Overrides:

beginTableRow in class AbstractChainingListener

See Also:

AbstractChainingListener.beginTableRow(java.util.Map)

beginTableCell

public void beginTableCell(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

beginTableCell in interface Listener

Overrides:

beginTableCell in class AbstractChainingListener

See Also:

AbstractChainingListener.beginTableCell(java.util.Map)

beginTableHeadCell

public void beginTableHeadCell(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

beginTableHeadCell in interface Listener

Overrides:

beginTableHeadCell in class AbstractChainingListener

See Also:

AbstractChainingListener.beginTableHeadCell(java.util.Map)

endTable

public void endTable(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

endTable in interface Listener

Overrides:

endTable in class AbstractChainingListener

See Also:

AbstractChainingListener.endTable(java.util.Map)

endTableRow

public void endTableRow(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

endTableRow in interface Listener

Overrides:

endTableRow in class AbstractChainingListener

See Also:

AbstractChainingListener.endTableRow(java.util.Map)

endTableCell

public void endTableCell(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

endTableCell in interface Listener

Overrides:

endTableCell in class AbstractChainingListener

See Also:

AbstractChainingListener.endTableCell(java.util.Map)

endTableHeadCell

public void endTableHeadCell(java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

endTableHeadCell in interface Listener

Overrides:

endTableHeadCell in class AbstractChainingListener

See Also:

AbstractChainingListener.endTableHeadCell(java.util.Map)

onImage

public void onImage(ResourceReference reference,
                    boolean isFreeStandingURI,
                    java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

onImage in interface ImageListener

Overrides:

onImage in class AbstractChainingListener

Since:

2.5RC1

See Also:

AbstractChainingListener.onImage(org.xwiki.rendering.listener.reference.ResourceReference , boolean, java.util.Map)

onRawText

public void onRawText(java.lang.String text,
                      Syntax syntax)

Specified by:

onRawText in interface Listener

Overrides:

onRawText in class AbstractChainingListener

See Also:

AbstractChainingListener.onRawText(String, Syntax)