org.xwiki.rendering.internal.renderer.xwiki20
Class XWikiSyntaxChainingRenderer

java.lang.Object
  org.xwiki.rendering.listener.chaining.AbstractChainingListener
      org.xwiki.rendering.renderer.AbstractChainingPrintRenderer
          org.xwiki.rendering.internal.renderer.xwiki20.XWikiSyntaxChainingRenderer

All Implemented Interfaces:

ChainingListener, StackableChainingListener, ImageListener, LinkListener, Listener, PrintRenderer, Renderer

Direct Known Subclasses:

XWikiSyntaxChainingRenderer

public class XWikiSyntaxChainingRenderer
extends AbstractChainingPrintRenderer
implements StackableChainingListener

Convert listener events to XWiki Syntax 2.0 output.

Since:

1.8RC1

Version:

$Id$

Field Summary

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

EMPTY_PARAMETERS

Constructor Summary

XWikiSyntaxChainingRenderer(ListenerChain listenerChain, ResourceReferenceSerializer linkReferenceSerializer, ResourceReferenceSerializer imageReferenceSerializer)

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	beginMacroMarker(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> parameters, java.lang.String content, boolean isInline)
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)
StackableChainingListener	createChainingListenerInstance()
protected XWikiSyntaxResourceRenderer	createXWikiSyntaxImageRenderer(ListenerChain listenerChain, ResourceReferenceSerializer imageReferenceSerializer)
protected XWikiSyntaxResourceRenderer	createXWikiSyntaxLinkRenderer(ListenerChain listenerChain, ResourceReferenceSerializer linkReferenceSerializer)
void	endDefinitionDescription()
void	endDefinitionTerm()
void	endDocument(MetaData metaData)
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	endMacroMarker(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> parameters, java.lang.String content, boolean isInline)
void	endParagraph(java.util.Map<java.lang.String,java.lang.String> parameters)
void	endQuotationLine()
void	endTableCell(java.util.Map<java.lang.String,java.lang.String> parameters)
void	endTableHeadCell(java.util.Map<java.lang.String,java.lang.String> parameters)
XWikiSyntaxEscapeWikiPrinter	getXWikiPrinter() Allows exposing the additional methods of XWikiSyntaxEscapeWikiPrinter, namely the ability to delay printing some text and the ability to escape characters that would otherwise have a meaning in XWiki syntax.
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	onMacro(java.lang.String id, java.util.Map<java.lang.String,java.lang.String> parameters, java.lang.String content, boolean isInline)
void	onNewLine()
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	printParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
protected void	printParameters(java.util.Map<java.lang.String,java.lang.String> parameters, boolean newLine)
void	setPrinter(WikiPrinter printer)

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

getMainPrinter, getPrinter, pushPrinter

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

beginDocument, beginMetaData, beginSection, endDefinitionList, endMetaData, endQuotation, endSection, endTable, endTableRow, getListenerChain, onRawText, 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.chaining.ChainingListener

getListenerChain

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

beginDocument, beginMetaData, beginSection, endDefinitionList, endMetaData, endQuotation, endSection, endTable, endTableRow, onRawText

Constructor Detail

XWikiSyntaxChainingRenderer

public XWikiSyntaxChainingRenderer(ListenerChain listenerChain,
                                   ResourceReferenceSerializer linkReferenceSerializer,
                                   ResourceReferenceSerializer imageReferenceSerializer)

Since:

2.5RC1

Method Detail

createXWikiSyntaxLinkRenderer

protected XWikiSyntaxResourceRenderer createXWikiSyntaxLinkRenderer(ListenerChain listenerChain,
                                                                    ResourceReferenceSerializer linkReferenceSerializer)

Since:

2.5RC1

createXWikiSyntaxImageRenderer

protected XWikiSyntaxResourceRenderer createXWikiSyntaxImageRenderer(ListenerChain listenerChain,
                                                                     ResourceReferenceSerializer imageReferenceSerializer)

Since:

2.5RC1

createChainingListenerInstance

public StackableChainingListener createChainingListenerInstance()

Specified by:

createChainingListenerInstance in interface StackableChainingListener

See Also:

StackableChainingListener.createChainingListenerInstance()

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)

endDocument

public void endDocument(MetaData metaData)

Specified by:

endDocument in interface Listener

Overrides:

endDocument in class AbstractChainingListener

Since:

3.0M2

See Also:

AbstractChainingListener.endDocument(MetaData)

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)

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, java.util.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, java.util.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(org.xwiki.rendering.listener.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(org.xwiki.rendering.listener.Format, java.util.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:

Listener.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:

Listener.endParagraph(java.util.Map)

onNewLine

public void onNewLine()

Specified by:

onNewLine in interface Listener

Overrides:

onNewLine in class AbstractChainingListener

See Also:

Listener.onNewLine()

onMacro

public void onMacro(java.lang.String id,
                    java.util.Map<java.lang.String,java.lang.String> parameters,
                    java.lang.String content,
                    boolean isInline)

Specified by:

onMacro in interface Listener

Overrides:

onMacro in class AbstractChainingListener

See Also:

AbstractChainingListener.onMacro(String, java.util.Map, String, boolean)

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(org.xwiki.rendering.listener.HeaderLevel, String, java.util.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(org.xwiki.rendering.listener.HeaderLevel, String, java.util.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:

Listener.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:

Listener.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()

beginMacroMarker

public void beginMacroMarker(java.lang.String name,
                             java.util.Map<java.lang.String,java.lang.String> parameters,
                             java.lang.String content,
                             boolean isInline)

Specified by:

beginMacroMarker in interface Listener

Overrides:

beginMacroMarker in class AbstractChainingListener

See Also:

AbstractChainingListener.beginMacroMarker(String, java.util.Map, String, boolean)

endMacroMarker

public void endMacroMarker(java.lang.String name,
                           java.util.Map<java.lang.String,java.lang.String> parameters,
                           java.lang.String content,
                           boolean isInline)

Specified by:

endMacroMarker in interface Listener

Overrides:

endMacroMarker in class AbstractChainingListener

See Also:

AbstractChainingListener.endMacroMarker(String, java.util.Map, String, boolean)

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:

Listener.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:

Listener.onVerbatim(String, boolean, Map)

onEmptyLines

public void onEmptyLines(int count)

Specified by:

onEmptyLines in interface Listener

Overrides:

onEmptyLines in class AbstractChainingListener

See Also:

Listener.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:

Listener.beginDefinitionList(java.util.Map)

beginDefinitionTerm

public void beginDefinitionTerm()

Specified by:

beginDefinitionTerm in interface Listener

Overrides:

beginDefinitionTerm in class AbstractChainingListener

Since:

1.6M2

See Also:

Listener.beginDefinitionTerm()

beginDefinitionDescription

public void beginDefinitionDescription()

Specified by:

beginDefinitionDescription in interface Listener

Overrides:

beginDefinitionDescription in class AbstractChainingListener

Since:

1.6M2

See Also:

Listener.beginDefinitionDescription()

endDefinitionDescription

public void endDefinitionDescription()

Specified by:

endDefinitionDescription in interface Listener

Overrides:

endDefinitionDescription in class AbstractChainingListener

See Also:

AbstractChainingListener.endDefinitionDescription()

endDefinitionTerm

public void endDefinitionTerm()

Specified by:

endDefinitionTerm in interface Listener

Overrides:

endDefinitionTerm in class AbstractChainingListener

See Also:

AbstractChainingListener.endDefinitionTerm()

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

Since:

1.6M2

See Also:

Listener.beginQuotation(java.util.Map)

beginQuotationLine

public void beginQuotationLine()

Specified by:

beginQuotationLine in interface Listener

Overrides:

beginQuotationLine in class AbstractChainingListener

Since:

1.6M2

See Also:

Listener.beginQuotationLine()

endQuotationLine

public void endQuotationLine()

Specified by:

endQuotationLine in interface Listener

Overrides:

endQuotationLine in class AbstractChainingListener

See Also:

AbstractChainingListener.endQuotationLine()

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:

Listener.beginTable(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:

Listener.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:

Listener.beginTableHeadCell(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:

Listener.beginTableRow(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:

Listener.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:

Listener.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:

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

printParameters

protected void printParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

printParameters

protected void printParameters(java.util.Map<java.lang.String,java.lang.String> parameters,
                               boolean newLine)

setPrinter

public void setPrinter(WikiPrinter printer)

Specified by:

setPrinter in interface PrintRenderer

Overrides:

setPrinter in class AbstractChainingPrintRenderer

Since:

2.0M3

See Also:

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

getXWikiPrinter

public XWikiSyntaxEscapeWikiPrinter getXWikiPrinter()

Allows exposing the additional methods of XWikiSyntaxEscapeWikiPrinter, namely the ability to delay printing some text and the ability to escape characters that would otherwise have a meaning in XWiki syntax.

popPrinter

protected void popPrinter()

Overrides:

popPrinter in class AbstractChainingPrintRenderer