org.exoplatform.wiki.rendering.render.confluence
Class ConfluenceSyntaxChainingRenderer

java.lang.Object
  org.xwiki.rendering.listener.chaining.AbstractChainingListener
      org.xwiki.rendering.renderer.AbstractChainingPrintRenderer
          org.exoplatform.wiki.rendering.render.confluence.ConfluenceSyntaxChainingRenderer

All Implemented Interfaces:

org.xwiki.rendering.listener.chaining.ChainingListener, org.xwiki.rendering.listener.chaining.StackableChainingListener, org.xwiki.rendering.listener.ImageListener, org.xwiki.rendering.listener.LinkListener, org.xwiki.rendering.listener.Listener, org.xwiki.rendering.renderer.PrintRenderer, org.xwiki.rendering.renderer.Renderer

public class ConfluenceSyntaxChainingRenderer
extends org.xwiki.rendering.renderer.AbstractChainingPrintRenderer
implements org.xwiki.rendering.listener.chaining.StackableChainingListener

Convert listener events to Confluence Syntax 1.0 output.

Field Summary

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

EMPTY_PARAMETERS

Constructor Summary

ConfluenceSyntaxChainingRenderer(org.xwiki.rendering.listener.chaining.ListenerChain listenerChain, org.xwiki.rendering.renderer.reference.ResourceReferenceSerializer linkReferenceSerializer, org.xwiki.rendering.transformation.icon.IconTransformationConfiguration iconTransformationConfiguration)

Method Summary

void	beginDefinitionDescription()
void	beginDefinitionList(Map<String,String> parameters)
void	beginDefinitionTerm()
void	beginFormat(org.xwiki.rendering.listener.Format format, Map<String,String> parameters)
void	beginGroup(Map<String,String> parameters)
void	beginHeader(org.xwiki.rendering.listener.HeaderLevel level, String id, Map<String,String> parameters)
void	beginLink(org.xwiki.rendering.listener.reference.ResourceReference link, boolean isFreeStandingURI, Map<String,String> parameters)
void	beginList(org.xwiki.rendering.listener.ListType listType, Map<String,String> parameters)
void	beginListItem()
void	beginMacroMarker(String name, Map<String,String> parameters, String content, boolean isInline)
void	beginParagraph(Map<String,String> parameters)
void	beginQuotation(Map<String,String> parameters)
void	beginQuotationLine()
void	beginTable(Map<String,String> parameters)
void	beginTableCell(Map<String,String> parameters)
void	beginTableHeadCell(Map<String,String> parameters)
void	beginTableRow(Map<String,String> parameters)
org.xwiki.rendering.listener.chaining.StackableChainingListener	createChainingListenerInstance()
void	endDefinitionDescription()
void	endDefinitionTerm()
void	endDocument(org.xwiki.rendering.listener.MetaData metaData)
void	endFormat(org.xwiki.rendering.listener.Format format, Map<String,String> parameters)
void	endGroup(Map<String,String> parameters)
void	endHeader(org.xwiki.rendering.listener.HeaderLevel level, String id, Map<String,String> parameters)
void	endLink(org.xwiki.rendering.listener.reference.ResourceReference link, boolean isFreeStandingURI, Map<String,String> parameters)
void	endList(org.xwiki.rendering.listener.ListType listType, Map<String,String> parameters)
void	endListItem()
void	endMacroMarker(String name, Map<String,String> parameters, String content, boolean isInline)
void	endParagraph(Map<String,String> parameters)
void	endQuotationLine()
void	endTableCell(Map<String,String> parameters)
void	endTableHeadCell(Map<String,String> parameters)
ConfluenceSyntaxEscapeWikiPrinter	getConfluencePrinter() Allows exposing the additional methods of ConfluenceSyntaxEscapeWikiPrinter, namely the ability to delay printing some text and the ability to escape characters that would otherwise have a meaning in Confluence syntax.
void	onEmptyLines(int count)
void	onHorizontalLine(Map<String,String> parameters)
void	onId(String name)
void	onImage(org.xwiki.rendering.listener.reference.ResourceReference image, boolean isFreeStandingURI, Map<String,String> parameters)
void	onMacro(String id, Map<String,String> parameters, String content, boolean isInline)
void	onNewLine()
void	onSpace()
void	onSpecialSymbol(char symbol)
void	onVerbatim(String protectedString, boolean isInline, Map<String,String> parameters)
void	onWord(String word)
protected void	popPrinter()
protected void	printBeginParameters(Map<String,String> parameters)
protected void	printBeginParameters(Map<String,String> parameters, boolean newLine)
protected void	printEndParameters(Map<String,String> parameters)
protected void	printEndParameters(Map<String,String> parameters, boolean newLine)
void	setPrinter(org.xwiki.rendering.renderer.printer.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

ConfluenceSyntaxChainingRenderer

public ConfluenceSyntaxChainingRenderer(org.xwiki.rendering.listener.chaining.ListenerChain listenerChain,
                                        org.xwiki.rendering.renderer.reference.ResourceReferenceSerializer linkReferenceSerializer,
                                        org.xwiki.rendering.transformation.icon.IconTransformationConfiguration iconTransformationConfiguration)

Method Detail

createChainingListenerInstance

public org.xwiki.rendering.listener.chaining.StackableChainingListener createChainingListenerInstance()

Specified by:

createChainingListenerInstance in interface org.xwiki.rendering.listener.chaining.StackableChainingListener

See Also:

StackableChainingListener.createChainingListenerInstance()

beginGroup

public void beginGroup(Map<String,String> parameters)

Specified by:

beginGroup in interface org.xwiki.rendering.listener.Listener

Overrides:

beginGroup in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

AbstractChainingListener.beginGroup(Map)

endDocument

public void endDocument(org.xwiki.rendering.listener.MetaData metaData)

Specified by:

endDocument in interface org.xwiki.rendering.listener.Listener

Overrides:

endDocument in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

org.xwiki.rendering.listener.chaining.AbstractChainingListener#endDocument(java.util.Map)

endGroup

public void endGroup(Map<String,String> parameters)

Specified by:

endGroup in interface org.xwiki.rendering.listener.Listener

Overrides:

endGroup in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

AbstractChainingListener.endGroup(Map)

beginLink

public void beginLink(org.xwiki.rendering.listener.reference.ResourceReference link,
                      boolean isFreeStandingURI,
                      Map<String,String> parameters)

Specified by:

beginLink in interface org.xwiki.rendering.listener.LinkListener

Overrides:

beginLink in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

org.xwiki.rendering.renderer.AbstractChainingPrintRenderer#beginLink(org.xwiki.rendering.listener.Link, boolean, java.util.Map)

endLink

public void endLink(org.xwiki.rendering.listener.reference.ResourceReference link,
                    boolean isFreeStandingURI,
                    Map<String,String> parameters)

Specified by:

endLink in interface org.xwiki.rendering.listener.LinkListener

Overrides:

endLink in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

org.xwiki.rendering.renderer.AbstractChainingPrintRenderer#endLink(org.xwiki.rendering.listener.Link, boolean, java.util.Map)

beginFormat

public void beginFormat(org.xwiki.rendering.listener.Format format,
                        Map<String,String> parameters)

Specified by:

beginFormat in interface org.xwiki.rendering.listener.Listener

Overrides:

beginFormat in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

AbstractChainingListener.beginFormat(org.xwiki.rendering.listener.Format, java.util.Map)

endFormat

public void endFormat(org.xwiki.rendering.listener.Format format,
                      Map<String,String> parameters)

Specified by:

endFormat in interface org.xwiki.rendering.listener.Listener

Overrides:

endFormat in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

AbstractChainingListener.endFormat(org.xwiki.rendering.listener.Format, java.util.Map)

beginParagraph

public void beginParagraph(Map<String,String> parameters)

Specified by:

beginParagraph in interface org.xwiki.rendering.listener.Listener

Overrides:

beginParagraph in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.beginParagraph(java.util.Map)

endParagraph

public void endParagraph(Map<String,String> parameters)

Specified by:

endParagraph in interface org.xwiki.rendering.listener.Listener

Overrides:

endParagraph in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.endParagraph(java.util.Map)

onNewLine

public void onNewLine()

Specified by:

onNewLine in interface org.xwiki.rendering.listener.Listener

Overrides:

onNewLine in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.onNewLine()

onMacro

public void onMacro(String id,
                    Map<String,String> parameters,
                    String content,
                    boolean isInline)

Specified by:

onMacro in interface org.xwiki.rendering.listener.Listener

Overrides:

onMacro in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

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

beginHeader

public void beginHeader(org.xwiki.rendering.listener.HeaderLevel level,
                        String id,
                        Map<String,String> parameters)

Specified by:

beginHeader in interface org.xwiki.rendering.listener.Listener

Overrides:

beginHeader in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

AbstractChainingListener.beginHeader(org.xwiki.rendering.listener.HeaderLevel, String, java.util.Map)

endHeader

public void endHeader(org.xwiki.rendering.listener.HeaderLevel level,
                      String id,
                      Map<String,String> parameters)

Specified by:

endHeader in interface org.xwiki.rendering.listener.Listener

Overrides:

endHeader in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

AbstractChainingListener.endHeader(org.xwiki.rendering.listener.HeaderLevel, String, java.util.Map)

onWord

public void onWord(String word)

Specified by:

onWord in interface org.xwiki.rendering.listener.Listener

Overrides:

onWord in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

AbstractChainingListener.onWord(String)

onSpace

public void onSpace()

Specified by:

onSpace in interface org.xwiki.rendering.listener.Listener

Overrides:

onSpace in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.onSpace()

onSpecialSymbol

public void onSpecialSymbol(char symbol)

Specified by:

onSpecialSymbol in interface org.xwiki.rendering.listener.Listener

Overrides:

onSpecialSymbol in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

AbstractChainingListener.onSpecialSymbol(char)

beginList

public void beginList(org.xwiki.rendering.listener.ListType listType,
                      Map<String,String> parameters)

Specified by:

beginList in interface org.xwiki.rendering.listener.Listener

Overrides:

beginList in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

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

beginListItem

public void beginListItem()

Specified by:

beginListItem in interface org.xwiki.rendering.listener.Listener

Overrides:

beginListItem in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.beginListItem()

endList

public void endList(org.xwiki.rendering.listener.ListType listType,
                    Map<String,String> parameters)

Specified by:

endList in interface org.xwiki.rendering.listener.Listener

Overrides:

endList in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

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

endListItem

public void endListItem()

Specified by:

endListItem in interface org.xwiki.rendering.listener.Listener

Overrides:

endListItem in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

AbstractChainingListener.endListItem()

beginMacroMarker

public void beginMacroMarker(String name,
                             Map<String,String> parameters,
                             String content,
                             boolean isInline)

Specified by:

beginMacroMarker in interface org.xwiki.rendering.listener.Listener

Overrides:

beginMacroMarker in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

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

endMacroMarker

public void endMacroMarker(String name,
                           Map<String,String> parameters,
                           String content,
                           boolean isInline)

Specified by:

endMacroMarker in interface org.xwiki.rendering.listener.Listener

Overrides:

endMacroMarker in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

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

onId

public void onId(String name)

Specified by:

onId in interface org.xwiki.rendering.listener.Listener

Overrides:

onId in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

AbstractChainingListener.onId(String)

onHorizontalLine

public void onHorizontalLine(Map<String,String> parameters)

Specified by:

onHorizontalLine in interface org.xwiki.rendering.listener.Listener

Overrides:

onHorizontalLine in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.onHorizontalLine(Map)

onVerbatim

public void onVerbatim(String protectedString,
                       boolean isInline,
                       Map<String,String> parameters)

Specified by:

onVerbatim in interface org.xwiki.rendering.listener.Listener

Overrides:

onVerbatim in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.onVerbatim(String, boolean, Map)

onEmptyLines

public void onEmptyLines(int count)

Specified by:

onEmptyLines in interface org.xwiki.rendering.listener.Listener

Overrides:

onEmptyLines in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.onEmptyLines(int)

beginDefinitionList

public void beginDefinitionList(Map<String,String> parameters)

Specified by:

beginDefinitionList in interface org.xwiki.rendering.listener.Listener

Overrides:

beginDefinitionList in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.beginDefinitionList(java.util.Map)

beginDefinitionTerm

public void beginDefinitionTerm()

Specified by:

beginDefinitionTerm in interface org.xwiki.rendering.listener.Listener

Overrides:

beginDefinitionTerm in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.beginDefinitionTerm()

beginDefinitionDescription

public void beginDefinitionDescription()

Specified by:

beginDefinitionDescription in interface org.xwiki.rendering.listener.Listener

Overrides:

beginDefinitionDescription in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.beginDefinitionDescription()

endDefinitionDescription

public void endDefinitionDescription()

Specified by:

endDefinitionDescription in interface org.xwiki.rendering.listener.Listener

Overrides:

endDefinitionDescription in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

AbstractChainingListener.endDefinitionDescription()

endDefinitionTerm

public void endDefinitionTerm()

Specified by:

endDefinitionTerm in interface org.xwiki.rendering.listener.Listener

Overrides:

endDefinitionTerm in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

AbstractChainingListener.endDefinitionTerm()

beginQuotation

public void beginQuotation(Map<String,String> parameters)

Specified by:

beginQuotation in interface org.xwiki.rendering.listener.Listener

Overrides:

beginQuotation in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.beginQuotation(java.util.Map)

beginQuotationLine

public void beginQuotationLine()

Specified by:

beginQuotationLine in interface org.xwiki.rendering.listener.Listener

Overrides:

beginQuotationLine in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.beginQuotationLine()

endQuotationLine

public void endQuotationLine()

Specified by:

endQuotationLine in interface org.xwiki.rendering.listener.Listener

Overrides:

endQuotationLine in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

AbstractChainingListener.endQuotationLine()

beginTable

public void beginTable(Map<String,String> parameters)

Specified by:

beginTable in interface org.xwiki.rendering.listener.Listener

Overrides:

beginTable in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.beginTable(java.util.Map)

beginTableCell

public void beginTableCell(Map<String,String> parameters)

Specified by:

beginTableCell in interface org.xwiki.rendering.listener.Listener

Overrides:

beginTableCell in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.beginTableCell(java.util.Map)

beginTableHeadCell

public void beginTableHeadCell(Map<String,String> parameters)

Specified by:

beginTableHeadCell in interface org.xwiki.rendering.listener.Listener

Overrides:

beginTableHeadCell in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.beginTableHeadCell(java.util.Map)

beginTableRow

public void beginTableRow(Map<String,String> parameters)

Specified by:

beginTableRow in interface org.xwiki.rendering.listener.Listener

Overrides:

beginTableRow in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.beginTableRow(java.util.Map)

endTableCell

public void endTableCell(Map<String,String> parameters)

Specified by:

endTableCell in interface org.xwiki.rendering.listener.Listener

Overrides:

endTableCell in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.endTableCell(java.util.Map)

endTableHeadCell

public void endTableHeadCell(Map<String,String> parameters)

Specified by:

endTableHeadCell in interface org.xwiki.rendering.listener.Listener

Overrides:

endTableHeadCell in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

Listener.endTableHeadCell(java.util.Map)

onImage

public void onImage(org.xwiki.rendering.listener.reference.ResourceReference image,
                    boolean isFreeStandingURI,
                    Map<String,String> parameters)

Specified by:

onImage in interface org.xwiki.rendering.listener.ImageListener

Overrides:

onImage in class org.xwiki.rendering.listener.chaining.AbstractChainingListener

See Also:

org.xwiki.rendering.listener.Listener#onImage(org.xwiki.rendering.listener.Image, boolean, Map)

printBeginParameters

protected void printBeginParameters(Map<String,String> parameters)

printEndParameters

protected void printEndParameters(Map<String,String> parameters)

printEndParameters

protected void printEndParameters(Map<String,String> parameters,
                                  boolean newLine)

printBeginParameters

protected void printBeginParameters(Map<String,String> parameters,
                                    boolean newLine)

setPrinter

public void setPrinter(org.xwiki.rendering.renderer.printer.WikiPrinter printer)

Specified by:

setPrinter in interface org.xwiki.rendering.renderer.PrintRenderer

Overrides:

setPrinter in class org.xwiki.rendering.renderer.AbstractChainingPrintRenderer

See Also:

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

getConfluencePrinter

public ConfluenceSyntaxEscapeWikiPrinter getConfluencePrinter()

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

popPrinter

protected void popPrinter()

Overrides:

popPrinter in class org.xwiki.rendering.renderer.AbstractChainingPrintRenderer