org.xwiki.rendering.internal.macro.html
Class HTMLMacroXHTMLChainingRenderer

java.lang.Object
  extended by org.xwiki.rendering.listener.chaining.AbstractChainingListener
      extended by org.xwiki.rendering.renderer.AbstractChainingPrintRenderer
          extended by org.xwiki.rendering.internal.renderer.xhtml.XHTMLChainingRenderer
              extended by org.xwiki.rendering.internal.macro.html.HTMLMacroXHTMLChainingRenderer
All Implemented Interfaces:
ChainingListener, ImageListener, LinkListener, Listener, PrintRenderer, Renderer

public class HTMLMacroXHTMLChainingRenderer
extends XHTMLChainingRenderer

Renderer that generates XHTML from a XDOM resulting from the parsing of text containing HTML mixed with wiki syntax. We override the default XHTML renderer since we want special behaviors, for example to not escape special symbols (since we don't want to escape HTML tags for example).

Since:
1.8.3
Version:
$Id $

Field Summary
 
Fields inherited from interface org.xwiki.rendering.listener.Listener
EMPTY_PARAMETERS
 
Constructor Summary
HTMLMacroXHTMLChainingRenderer(XHTMLLinkRenderer linkRenderer, XHTMLImageRenderer imageRenderer, ListenerChain listenerChain)
           
 
Method Summary
 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 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 onEmptyLines(int count)
          
 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 onWord(java.lang.String word)
          
 
Methods inherited from class org.xwiki.rendering.internal.renderer.xhtml.XHTMLChainingRenderer
beginDefinitionDescription, beginDefinitionList, beginDefinitionTerm, beginFormat, beginGroup, beginHeader, beginLink, beginList, beginListItem, beginQuotation, beginQuotationLine, beginTable, beginTableCell, beginTableHeadCell, beginTableRow, endDefinitionDescription, endDefinitionList, endDefinitionTerm, endFormat, endGroup, endHeader, endLink, endList, endListItem, endQuotation, endTable, endTableCell, endTableHeadCell, endTableRow, getBlockState, getEmptyBlockState, getMetaDataState, getXHTMLWikiPrinter, onHorizontalLine, onId, onImage, onRawText, onVerbatim, popPrinter, pushPrinter
 
Methods inherited from class org.xwiki.rendering.renderer.AbstractChainingPrintRenderer
getMainPrinter, getPrinter, setPrinter
 
Methods inherited from class org.xwiki.rendering.listener.chaining.AbstractChainingListener
beginDocument, beginMetaData, beginSection, endDocument, endMetaData, endQuotationLine, endSection, getListenerChain, 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, beginMetaData, beginSection, endDocument, endMetaData, endQuotationLine, endSection
 

Constructor Detail

HTMLMacroXHTMLChainingRenderer

public HTMLMacroXHTMLChainingRenderer(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
Since:
2.0M3
Method Detail

onSpecialSymbol

public void onSpecialSymbol(char symbol)

Specified by:
onSpecialSymbol in interface Listener
Overrides:
onSpecialSymbol in class XHTMLChainingRenderer
See Also:
XHTMLChainingRenderer.onSpecialSymbol(char)

onWord

public void onWord(java.lang.String word)

Specified by:
onWord in interface Listener
Overrides:
onWord in class XHTMLChainingRenderer
See Also:
XHTMLChainingRenderer.onWord(String)

onNewLine

public void onNewLine()

Specified by:
onNewLine in interface Listener
Overrides:
onNewLine in class XHTMLChainingRenderer
See Also:
XHTMLChainingRenderer.onNewLine()

onSpace

public void onSpace()

Specified by:
onSpace in interface Listener
Overrides:
onSpace in class XHTMLChainingRenderer
See Also:
XHTMLChainingRenderer.onSpace()

onEmptyLines

public void onEmptyLines(int count)

Specified by:
onEmptyLines in interface Listener
Overrides:
onEmptyLines in class XHTMLChainingRenderer
See Also:
XHTMLChainingRenderer.onEmptyLines(int)

beginParagraph

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

Specified by:
beginParagraph in interface Listener
Overrides:
beginParagraph in class XHTMLChainingRenderer
See Also:
XHTMLChainingRenderer.beginParagraph(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 XHTMLChainingRenderer
See Also:
XHTMLChainingRenderer.endParagraph(Map)

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(java.lang.String, java.util.Map, java.lang.String, boolean)

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(java.lang.String, java.util.Map, java.lang.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(java.lang.String, java.util.Map, java.lang.String, boolean)


Copyright © 2004-2011 XWiki. All Rights Reserved.