Class WikiSerializerHandler
java.lang.Object
org.wikimodel.wem.PrintTextListener
org.wikimodel.wem.PrintInlineListener
org.wikimodel.wem.PrintListener
org.nuxeo.ecm.platform.rendering.wiki.WikiSerializerHandler
- All Implemented Interfaces:
org.wikimodel.wem.IWemListener
public class WikiSerializerHandler
extends org.wikimodel.wem.PrintListener
- Author:
- Bogdan Stefanescu
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final WikiSerializerprotected freemarker.core.Environmentprotected static final Stringprotected intprotected Tocprotected final StringBuilderprotected WikiWriterFields inherited from class org.wikimodel.wem.PrintTextListener
fRefHandler -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidbeginDefinitionList(org.wikimodel.wem.WikiParameters parameters) voidvoidprotected voidvoidbeginFormat(org.wikimodel.wem.WikiFormat format) voidbeginHeader(int level, org.wikimodel.wem.WikiParameters params) voidbeginInfoBlock(char infoType, org.wikimodel.wem.WikiParameters params) voidbeginList(org.wikimodel.wem.WikiParameters parameters, boolean ordered) voidvoidbeginParagraph(org.wikimodel.wem.WikiParameters params) voidbeginPropertyBlock(String propertyUri, boolean doc) voidvoidbeginQuotation(org.wikimodel.wem.WikiParameters params) voidvoidbeginTable(org.wikimodel.wem.WikiParameters params) voidbeginTableCell(boolean tableHead, org.wikimodel.wem.WikiParameters params) voidbeginTableRow(org.wikimodel.wem.WikiParameters params) voidvoidendDefinitionList(org.wikimodel.wem.WikiParameters parameters) voidvoidprotected voidvoidendFormat(org.wikimodel.wem.WikiFormat format) voidendHeader(int level, org.wikimodel.wem.WikiParameters params) voidendInfoBlock(char infoType, org.wikimodel.wem.WikiParameters params) voidendList(org.wikimodel.wem.WikiParameters parameters, boolean ordered) voidvoidendParagraph(org.wikimodel.wem.WikiParameters params) voidendPropertyBlock(String propertyUri, boolean doc) voidendPropertyInline(String inlineProperty) voidendQuotation(org.wikimodel.wem.WikiParameters params) voidvoidendTable(org.wikimodel.wem.WikiParameters params) voidendTableCell(boolean tableHead, org.wikimodel.wem.WikiParameters params) voidendTableRow(org.wikimodel.wem.WikiParameters params) protected voidfreemarker.core.Environmentprotected StringgetSymbolEntity(String str) Returns an HTML/XML entity corresponding to the specified special symbol.protected booleanReturnstrueif special Wiki entities should be represented as the corresponding HTML entities or they should be visualized using the corresponding XHTML codes (like & and so on).voidonEmptyLines(int count) voidvoidonExtensionBlock(String extensionName, org.wikimodel.wem.WikiParameters params) voidonExtensionInline(String extensionName, org.wikimodel.wem.WikiParameters params) voidvoidvoidonMacroBlock(String macroName, org.wikimodel.wem.WikiParameters params, String content) voidonMacroInline(String macroName, org.wikimodel.wem.WikiParameters params, String content) voidvoidonReference(String ref, boolean explicitLink) voidvoidonSpecialSymbol(String str) voidonTableCaption(String str) voidonVerbatimBlock(String str) voidonVerbatimInline(String str) voidprotected voidprotected voidprintln()protected voidprotected voidMethods inherited from class org.wikimodel.wem.PrintInlineListener
newReferenceHandlerMethods inherited from class org.wikimodel.wem.PrintTextListener
endBlock
-
Field Details
-
LINE_SEP
-
engine
-
words
-
env
protected freemarker.core.Environment env -
writer
-
mark
protected int mark -
toc
-
-
Constructor Details
-
WikiSerializerHandler
-
-
Method Details
-
print
- Overrides:
printin classorg.wikimodel.wem.PrintTextListener
-
println
protected void println()- Overrides:
printlnin classorg.wikimodel.wem.PrintTextListener
-
println
- Overrides:
printlnin classorg.wikimodel.wem.PrintTextListener
-
getWriter
-
getEnvironment
public freemarker.core.Environment getEnvironment() -
beginElement
protected void beginElement() -
endElement
protected void endElement() -
flushWords
protected void flushWords() -
beginDefinitionDescription
public void beginDefinitionDescription()- Specified by:
beginDefinitionDescriptionin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginDefinitionDescriptionin classorg.wikimodel.wem.PrintListener
-
beginDefinitionList
public void beginDefinitionList(org.wikimodel.wem.WikiParameters parameters) - Specified by:
beginDefinitionListin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginDefinitionListin classorg.wikimodel.wem.PrintListener
-
beginDefinitionTerm
public void beginDefinitionTerm()- Specified by:
beginDefinitionTermin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginDefinitionTermin classorg.wikimodel.wem.PrintListener
-
beginDocument
public void beginDocument()- Specified by:
beginDocumentin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginDocumentin classorg.wikimodel.wem.PrintListener
-
beginFormat
public void beginFormat(org.wikimodel.wem.WikiFormat format) - Specified by:
beginFormatin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginFormatin classorg.wikimodel.wem.PrintInlineListener
-
beginHeader
public void beginHeader(int level, org.wikimodel.wem.WikiParameters params) - Specified by:
beginHeaderin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginHeaderin classorg.wikimodel.wem.PrintListener
-
beginInfoBlock
public void beginInfoBlock(char infoType, org.wikimodel.wem.WikiParameters params) - Specified by:
beginInfoBlockin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginInfoBlockin classorg.wikimodel.wem.PrintListener
-
beginList
public void beginList(org.wikimodel.wem.WikiParameters parameters, boolean ordered) - Specified by:
beginListin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginListin classorg.wikimodel.wem.PrintListener
-
beginListItem
public void beginListItem()- Specified by:
beginListItemin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginListItemin classorg.wikimodel.wem.PrintListener
-
beginParagraph
public void beginParagraph(org.wikimodel.wem.WikiParameters params) - Specified by:
beginParagraphin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginParagraphin classorg.wikimodel.wem.PrintListener
-
beginPropertyBlock
- Specified by:
beginPropertyBlockin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginPropertyBlockin classorg.wikimodel.wem.PrintListener
-
beginPropertyInline
- Specified by:
beginPropertyInlinein interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginPropertyInlinein classorg.wikimodel.wem.PrintInlineListener
-
beginQuotation
public void beginQuotation(org.wikimodel.wem.WikiParameters params) - Specified by:
beginQuotationin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginQuotationin classorg.wikimodel.wem.PrintListener
-
beginQuotationLine
public void beginQuotationLine()- Specified by:
beginQuotationLinein interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginQuotationLinein classorg.wikimodel.wem.PrintListener
-
beginTable
public void beginTable(org.wikimodel.wem.WikiParameters params) - Specified by:
beginTablein interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginTablein classorg.wikimodel.wem.PrintListener
-
beginTableCell
public void beginTableCell(boolean tableHead, org.wikimodel.wem.WikiParameters params) - Specified by:
beginTableCellin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginTableCellin classorg.wikimodel.wem.PrintListener
-
beginTableRow
public void beginTableRow(org.wikimodel.wem.WikiParameters params) - Specified by:
beginTableRowin interfaceorg.wikimodel.wem.IWemListener- Overrides:
beginTableRowin classorg.wikimodel.wem.PrintListener
-
endDefinitionDescription
public void endDefinitionDescription()- Specified by:
endDefinitionDescriptionin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endDefinitionDescriptionin classorg.wikimodel.wem.PrintListener
-
endDefinitionList
public void endDefinitionList(org.wikimodel.wem.WikiParameters parameters) - Specified by:
endDefinitionListin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endDefinitionListin classorg.wikimodel.wem.PrintListener
-
endDefinitionTerm
public void endDefinitionTerm()- Specified by:
endDefinitionTermin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endDefinitionTermin classorg.wikimodel.wem.PrintListener
-
endDocument
public void endDocument()- Specified by:
endDocumentin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endDocumentin classorg.wikimodel.wem.PrintListener
-
endFormat
public void endFormat(org.wikimodel.wem.WikiFormat format) - Specified by:
endFormatin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endFormatin classorg.wikimodel.wem.PrintInlineListener
-
endHeader
public void endHeader(int level, org.wikimodel.wem.WikiParameters params) - Specified by:
endHeaderin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endHeaderin classorg.wikimodel.wem.PrintListener
-
endInfoBlock
public void endInfoBlock(char infoType, org.wikimodel.wem.WikiParameters params) - Specified by:
endInfoBlockin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endInfoBlockin classorg.wikimodel.wem.PrintListener
-
endList
public void endList(org.wikimodel.wem.WikiParameters parameters, boolean ordered) - Specified by:
endListin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endListin classorg.wikimodel.wem.PrintListener
-
endListItem
public void endListItem()- Specified by:
endListItemin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endListItemin classorg.wikimodel.wem.PrintListener
-
endParagraph
public void endParagraph(org.wikimodel.wem.WikiParameters params) - Specified by:
endParagraphin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endParagraphin classorg.wikimodel.wem.PrintListener
-
endPropertyBlock
- Specified by:
endPropertyBlockin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endPropertyBlockin classorg.wikimodel.wem.PrintListener
-
endPropertyInline
- Specified by:
endPropertyInlinein interfaceorg.wikimodel.wem.IWemListener- Overrides:
endPropertyInlinein classorg.wikimodel.wem.PrintInlineListener
-
endQuotation
public void endQuotation(org.wikimodel.wem.WikiParameters params) - Specified by:
endQuotationin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endQuotationin classorg.wikimodel.wem.PrintListener
-
endQuotationLine
public void endQuotationLine()- Specified by:
endQuotationLinein interfaceorg.wikimodel.wem.IWemListener- Overrides:
endQuotationLinein classorg.wikimodel.wem.PrintListener
-
endTable
public void endTable(org.wikimodel.wem.WikiParameters params) - Specified by:
endTablein interfaceorg.wikimodel.wem.IWemListener- Overrides:
endTablein classorg.wikimodel.wem.PrintListener
-
endTableCell
public void endTableCell(boolean tableHead, org.wikimodel.wem.WikiParameters params) - Specified by:
endTableCellin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endTableCellin classorg.wikimodel.wem.PrintListener
-
endTableRow
public void endTableRow(org.wikimodel.wem.WikiParameters params) - Specified by:
endTableRowin interfaceorg.wikimodel.wem.IWemListener- Overrides:
endTableRowin classorg.wikimodel.wem.PrintListener
-
onEmptyLines
public void onEmptyLines(int count) - Specified by:
onEmptyLinesin interfaceorg.wikimodel.wem.IWemListener- Overrides:
onEmptyLinesin classorg.wikimodel.wem.PrintListener
-
onHorizontalLine
public void onHorizontalLine()- Specified by:
onHorizontalLinein interfaceorg.wikimodel.wem.IWemListener- Overrides:
onHorizontalLinein classorg.wikimodel.wem.PrintListener
-
onLineBreak
public void onLineBreak()- Specified by:
onLineBreakin interfaceorg.wikimodel.wem.IWemListener- Overrides:
onLineBreakin classorg.wikimodel.wem.PrintInlineListener
-
onReference
- Specified by:
onReferencein interfaceorg.wikimodel.wem.IWemListener- Overrides:
onReferencein classorg.wikimodel.wem.PrintTextListener
-
onTableCaption
- Specified by:
onTableCaptionin interfaceorg.wikimodel.wem.IWemListener- Overrides:
onTableCaptionin classorg.wikimodel.wem.PrintListener
-
onVerbatimBlock
- Specified by:
onVerbatimBlockin interfaceorg.wikimodel.wem.IWemListener- Overrides:
onVerbatimBlockin classorg.wikimodel.wem.PrintListener
-
onVerbatimInline
- Specified by:
onVerbatimInlinein interfaceorg.wikimodel.wem.IWemListener- Overrides:
onVerbatimInlinein classorg.wikimodel.wem.PrintInlineListener
-
onMacroBlock
- Specified by:
onMacroBlockin interfaceorg.wikimodel.wem.IWemListener- Overrides:
onMacroBlockin classorg.wikimodel.wem.PrintListener
-
onMacroInline
public void onMacroInline(String macroName, org.wikimodel.wem.WikiParameters params, String content) - Specified by:
onMacroInlinein interfaceorg.wikimodel.wem.IWemListener- Overrides:
onMacroInlinein classorg.wikimodel.wem.PrintListener
-
onExtensionBlock
- Specified by:
onExtensionBlockin interfaceorg.wikimodel.wem.IWemListener- Overrides:
onExtensionBlockin classorg.wikimodel.wem.PrintListener
-
onExtensionInline
- Specified by:
onExtensionInlinein interfaceorg.wikimodel.wem.IWemListener- Overrides:
onExtensionInlinein classorg.wikimodel.wem.PrintInlineListener
-
onSpecialSymbol
- Specified by:
onSpecialSymbolin interfaceorg.wikimodel.wem.IWemListener- Overrides:
onSpecialSymbolin classorg.wikimodel.wem.PrintInlineListener
-
onSpace
- Specified by:
onSpacein interfaceorg.wikimodel.wem.IWemListener- Overrides:
onSpacein classorg.wikimodel.wem.PrintTextListener
-
onNewLine
public void onNewLine()- Specified by:
onNewLinein interfaceorg.wikimodel.wem.IWemListener- Overrides:
onNewLinein classorg.wikimodel.wem.PrintTextListener
-
onEscape
- Specified by:
onEscapein interfaceorg.wikimodel.wem.IWemListener- Overrides:
onEscapein classorg.wikimodel.wem.PrintInlineListener
-
onWord
- Specified by:
onWordin interfaceorg.wikimodel.wem.IWemListener- Overrides:
onWordin classorg.wikimodel.wem.PrintTextListener
-
writeWord
-
getSymbolEntity
Returns an HTML/XML entity corresponding to the specified special symbol. Depending on implementation it can be real entities (like & < > or the corresponding digital codes (like &, &#& or ›). Digital entity representation is better for generation of XML files.- Parameters:
str- the special string to convert to an HTML/XML entity- Returns:
- an HTML/XML entity corresponding to the specified special symbol.
-
isHtmlEntities
protected boolean isHtmlEntities()Returnstrueif special Wiki entities should be represented as the corresponding HTML entities or they should be visualized using the corresponding XHTML codes (like & and so on). This method can be overloaded in subclasses to re-define the visualization style.- Returns:
trueif special Wiki entities should be represented as the corresponding HTML entities or they should be visualized using the corresponding XHTML codes (like & and so on).
-