public class PrintListener extends PrintInlineListener
fRefHandler
Constructor and Description |
---|
PrintListener(IWikiPrinter printer) |
PrintListener(IWikiPrinter printer,
boolean supportImage,
boolean supportDownload) |
Modifier and Type | Method and Description |
---|---|
void |
beginDefinitionDescription()
This method is used to notify about a definition description.
|
void |
beginDefinitionList(WikiParameters parameters)
This method is used to notify about a new definition list.
|
void |
beginDefinitionTerm()
A definition term.
|
void |
beginDocument(WikiParameters params)
This method is called to notify about the beginning of the top-level parsed document or about the beginning of an
embedded document (contained in the main one).
|
void |
beginHeader(int headerLevel,
WikiParameters params)
This method is called to notify about a new section header found in the document.
|
void |
beginInfoBlock(String infoType,
WikiParameters params)
This method is used to notify about the beginning of a "typed" paragraph.
|
void |
beginList(WikiParameters parameters,
boolean ordered)
This method is used to notify about a new list.
|
void |
beginListItem()
This method is used to notify about the beginning of a new item of a
simple list (see
IWemListenerList.beginList(WikiParameters, boolean) /
IWemListenerList.endList(WikiParameters, boolean) methods). |
void |
beginListItem(WikiParameters params)
This method is used to notify about the beginning of a new item of a
simple list (see
IWemListenerList.beginList(WikiParameters, boolean) /
IWemListenerList.endList(WikiParameters, boolean) methods). |
void |
beginParagraph(WikiParameters params)
Begin of a simple paragraph.
|
void |
beginPropertyBlock(String propertyUri,
boolean doc)
This method is called to notify about the beginning of a new property
found in the parsed document.
|
void |
beginQuotation(WikiParameters params)
Notifies about the beginning of a quotation elements.
|
void |
beginQuotationLine()
A list containing quotation.
|
void |
beginTable(WikiParameters params)
This method notifies about the beginning of a new table in the document.
|
void |
beginTableCell(boolean tableHead,
WikiParameters params)
This method is used to notify about the beginning of a new table cell.
|
void |
beginTableRow(WikiParameters params)
This method is used to notify about the beginning of a new table row.
|
void |
endDefinitionDescription()
This method is used to notify about the end of a definition description.
|
void |
endDefinitionList(WikiParameters parameters)
This method is used to notify about the end of a definition list.
|
void |
endDefinitionTerm()
The end of a definition term.
|
void |
endDocument(WikiParameters params)
This method is used to notify about the end of a top-level or an internal document.
|
void |
endHeader(int headerLevel,
WikiParameters params)
This method is called to notify about the end of a section-level header.
|
void |
endInfoBlock(String infoType,
WikiParameters params)
This method is used to notify about the end of a "typed" paragraph.
|
void |
endList(WikiParameters parameters,
boolean ordered)
This method is used to notify about the end of a list.
|
void |
endListItem()
This method is used to notify about the end of an item of a simple list
(see
IWemListenerList.beginList(WikiParameters, boolean) /
IWemListenerList.endList(WikiParameters, boolean) methods). |
void |
endListItem(WikiParameters params)
This method is used to notify about the end of an item of a simple list
(see
IWemListenerList.beginList(WikiParameters, boolean) /
IWemListenerList.endList(WikiParameters, boolean) methods). |
void |
endParagraph(WikiParameters params)
End of a simple paragraph.
|
void |
endPropertyBlock(String propertyUri,
boolean doc)
This method is called to notify about the end of a block property found
in the parsed document.
|
void |
endQuotation(WikiParameters params)
Notifies about the end of a quotation element sequence.
|
void |
endQuotationLine()
This method is used to notify about the end of a quotation line.
|
void |
endTable(WikiParameters params)
This method notifies about the end of a table in the document.
|
void |
endTableCell(boolean tableHead,
WikiParameters params)
This method is used to notify about the end of a table cell.
|
void |
endTableRow(WikiParameters params)
This method is used to notify about the end of a table row.
|
void |
onEmptyLines(int count)
This method is used to notify about a sequence of empty lines.
|
void |
onExtensionBlock(String extensionName,
WikiParameters params)
This method is used to notify about a new extension which CAN generate
block elements as a result of its interpretation.
|
void |
onHorizontalLine(WikiParameters params)
This method notifies horizontal lines defined in the text.
|
void |
onMacroBlock(String macroName,
WikiParameters params,
String content)
This method is used to notify about a new in-line macro which CAN
generate block elements as a result of its interpretation.
|
void |
onMacroInline(String macroName,
WikiParameters params,
String content)
This method is used to notify about a new in-line macro which CAN
generate only in-line elements as a result of its interpretation.
|
void |
onTableCaption(String str)
Notifies the table caption.
|
void |
onVerbatimBlock(String str,
WikiParameters params)
This method notifies about a verbatim (pre-formatted) block defined in
the text
|
beginFormat, beginPropertyInline, endFormat, endPropertyInline, getSymbolEntity, isHtmlEntities, newReferenceHandler, onEscape, onExtensionInline, onLineBreak, onSpecialSymbol, onVerbatimInline
beginSection, beginSectionContent, endBlock, endSection, endSectionContent, isSupportDownload, isSupportImage, onImage, onImage, onNewLine, onReference, onReference, onSpace, onWord, print, println, println
public PrintListener(IWikiPrinter printer)
printer
- public PrintListener(IWikiPrinter printer, boolean supportImage, boolean supportDownload)
public void beginDefinitionDescription()
IWemListenerList
beginDefinitionDescription
in interface IWemListenerList
beginDefinitionDescription
in class PrintTextListener
IWemListenerList.beginDefinitionDescription()
public void beginDefinitionList(WikiParameters parameters)
IWemListenerList
beginDefinitionList
in interface IWemListenerList
beginDefinitionList
in class PrintTextListener
parameters
- list of parameters for the listIWemListenerList.beginDefinitionList(WikiParameters)
public void beginDefinitionTerm()
IWemListenerList
beginDefinitionTerm
in interface IWemListenerList
beginDefinitionTerm
in class PrintTextListener
IWemListenerList.beginDefinitionTerm()
public void beginDocument(WikiParameters params)
IWemListenerDocument
beginDocument
in interface IWemListenerDocument
beginDocument
in class PrintTextListener
params
- the list of parameters for this eventIWemListenerDocument.beginDocument(WikiParameters)
public void beginHeader(int headerLevel, WikiParameters params)
IWemListenerDocument
beginHeader
in interface IWemListenerDocument
beginHeader
in class PrintTextListener
headerLevel
- the level of the found header; valid values: 1-6params
- the list of parameters for this eventIWemListenerDocument.beginHeader(int, WikiParameters)
public void beginInfoBlock(String infoType, WikiParameters params)
IWemListenerSimpleBlocks
beginInfoBlock
in interface IWemListenerSimpleBlocks
beginInfoBlock
in class PrintTextListener
infoType
- the "type" of the special blockparams
- parameters of this blockIWemListenerSimpleBlocks.beginInfoBlock(String,
WikiParameters)
public void beginList(WikiParameters parameters, boolean ordered)
IWemListenerList
IWemListenerList.beginListItem()
/IWemListenerList.endListItem()
method pair. Items of
lists of this type can contain the following sequence of elements:
beginList
in interface IWemListenerList
beginList
in class PrintTextListener
parameters
- parameters of the listordered
- if this flag is true
then this method
corresponds to a new ordered list ("ol"); otherwise this method
notifies a beginning of an unordered list ("ul")IWemListenerList.beginList(WikiParameters,
boolean)
public void beginListItem()
IWemListenerList
IWemListenerList.beginList(WikiParameters, boolean)
/
IWemListenerList.endList(WikiParameters, boolean)
methods).beginListItem
in interface IWemListenerList
beginListItem
in class PrintTextListener
IWemListenerList.beginListItem()
public void beginListItem(WikiParameters params)
IWemListenerList
IWemListenerList.beginList(WikiParameters, boolean)
/
IWemListenerList.endList(WikiParameters, boolean)
methods).beginListItem
in interface IWemListenerList
beginListItem
in class PrintTextListener
IWemListenerList.endListItem(WikiParameters)
public void beginParagraph(WikiParameters params)
IWemListenerSimpleBlocks
beginParagraph
in interface IWemListenerSimpleBlocks
beginParagraph
in class PrintTextListener
params
- paragraph parametersIWemListenerSimpleBlocks.beginParagraph(WikiParameters)
public void beginPropertyBlock(String propertyUri, boolean doc)
IWemListenerSemantic
beginPropertyBlock
in interface IWemListenerSemantic
beginPropertyBlock
in class PrintTextListener
propertyUri
- the URI of the semantic block property found in the
documentdoc
- this flag is true
if the found property contains
a whole document; if this flag is false
then expected
property value contains a paragraphIWemListenerSemantic.beginPropertyBlock(java.lang.String,
boolean)
public void beginQuotation(WikiParameters params)
IWemListenerList
beginQuotation
in interface IWemListenerList
beginQuotation
in class PrintTextListener
params
- parameters of the listIWemListenerList.beginQuotation(WikiParameters)
public void beginQuotationLine()
IWemListenerList
beginQuotationLine
in interface IWemListenerList
beginQuotationLine
in class PrintTextListener
IWemListenerList.beginQuotationLine()
public void beginTable(WikiParameters params)
IWemListenerTable
beginTable
in interface IWemListenerTable
beginTable
in class PrintTextListener
params
- table parametersIWemListenerTable.beginTable(WikiParameters)
public void beginTableCell(boolean tableHead, WikiParameters params)
IWemListenerTable
beginTableCell
in interface IWemListenerTable
beginTableCell
in class PrintTextListener
tableHead
- if this flag is true
then the reported cell
corresponds to the table head ("th" element); otherwise it should
be considered as a normal table cell ("td" element).params
- parameters of this cellIWemListenerTable.beginTableCell(boolean,
WikiParameters)
public void beginTableRow(WikiParameters params)
IWemListenerTable
beginTableRow
in interface IWemListenerTable
beginTableRow
in class PrintTextListener
params
- parameters of the row.IWemListenerTable.beginTableRow(WikiParameters)
public void endDefinitionDescription()
IWemListenerList
endDefinitionDescription
in interface IWemListenerList
endDefinitionDescription
in class PrintTextListener
IWemListenerList.endDefinitionDescription()
public void endDefinitionList(WikiParameters parameters)
IWemListenerList
endDefinitionList
in interface IWemListenerList
endDefinitionList
in class PrintTextListener
parameters
- list of parameters for the listIWemListenerList.endDefinitionList(WikiParameters)
public void endDefinitionTerm()
IWemListenerList
endDefinitionTerm
in interface IWemListenerList
endDefinitionTerm
in class PrintTextListener
IWemListenerList.endDefinitionTerm()
public void endDocument(WikiParameters params)
IWemListenerDocument
endDocument
in interface IWemListenerDocument
endDocument
in class PrintTextListener
params
- the list of parameters for this eventIWemListenerDocument.endDocument(WikiParameters)
public void endHeader(int headerLevel, WikiParameters params)
IWemListenerDocument
endHeader
in interface IWemListenerDocument
endHeader
in class PrintTextListener
headerLevel
- the level of the headerparams
- the list of parameters for this eventIWemListenerDocument.endHeader(int, WikiParameters)
public void endInfoBlock(String infoType, WikiParameters params)
IWemListenerSimpleBlocks
endInfoBlock
in interface IWemListenerSimpleBlocks
endInfoBlock
in class PrintTextListener
infoType
- the "type" of the special blockparams
- parameters of this blockIWemListenerSimpleBlocks.endInfoBlock(String,
WikiParameters)
public void endList(WikiParameters parameters, boolean ordered)
IWemListenerList
endList
in interface IWemListenerList
endList
in class PrintTextListener
parameters
- parameters of the listordered
- if this flag is true
then this method
corresponds to a new ordered list ("ol"); otherwise this method
notifies a beginning of an unordered list ("ul")IWemListenerList.endList(WikiParameters,
boolean)
public void endListItem()
IWemListenerList
IWemListenerList.beginList(WikiParameters, boolean)
/
IWemListenerList.endList(WikiParameters, boolean)
methods).endListItem
in interface IWemListenerList
endListItem
in class PrintTextListener
IWemListenerList.endListItem()
public void endListItem(WikiParameters params)
IWemListenerList
IWemListenerList.beginList(WikiParameters, boolean)
/
IWemListenerList.endList(WikiParameters, boolean)
methods).endListItem
in interface IWemListenerList
endListItem
in class PrintTextListener
IWemListenerList.beginListItem(WikiParameters)
public void endParagraph(WikiParameters params)
IWemListenerSimpleBlocks
endParagraph
in interface IWemListenerSimpleBlocks
endParagraph
in class PrintTextListener
params
- paragraph parametersIWemListenerSimpleBlocks.endParagraph(WikiParameters)
public void endPropertyBlock(String propertyUri, boolean doc)
IWemListenerSemantic
endPropertyBlock
in interface IWemListenerSemantic
endPropertyBlock
in class PrintTextListener
propertyUri
- the URI of the semantic block property found in the
documentdoc
- this flag is true
if the found property contains
a whole document; otherwise (if this flag is false
)
the value of the property is a simple paragraphIWemListenerSemantic.endPropertyBlock(java.lang.String,
boolean)
public void endQuotation(WikiParameters params)
IWemListenerList
endQuotation
in interface IWemListenerList
endQuotation
in class PrintTextListener
params
- parameters of the listIWemListenerList.endQuotation(WikiParameters)
public void endQuotationLine()
IWemListenerList
endQuotationLine
in interface IWemListenerList
endQuotationLine
in class PrintTextListener
IWemListenerList.endQuotationLine()
public void endTable(WikiParameters params)
IWemListenerTable
endTable
in interface IWemListenerTable
endTable
in class PrintTextListener
params
- table parametersIWemListenerTable.endTable(WikiParameters)
public void endTableCell(boolean tableHead, WikiParameters params)
IWemListenerTable
endTableCell
in interface IWemListenerTable
endTableCell
in class PrintTextListener
tableHead
- if this flag is true
then the reported cell
corresponds to the table head ("th" element); otherwise it should
be considered as a normal table cell ("td" element).params
- parameters of this cellIWemListenerTable.endTableCell(boolean, WikiParameters)
public void endTableRow(WikiParameters params)
IWemListenerTable
endTableRow
in interface IWemListenerTable
endTableRow
in class PrintTextListener
params
- parameters of the row.IWemListenerTable.endTableRow(WikiParameters)
public void onEmptyLines(int count)
IWemListenerSimpleBlocks
onEmptyLines
in interface IWemListenerSimpleBlocks
onEmptyLines
in class PrintTextListener
count
- the number of empty lines found in the textpublic void onExtensionBlock(String extensionName, WikiParameters params)
IWemListenerProgramming
onExtensionBlock
in interface IWemListenerProgramming
onExtensionBlock
in class PrintTextListener
extensionName
- the name of the extensionparams
- parameters for the extensionPrintTextListener.onExtensionBlock(java.lang.String,
org.xwiki.rendering.wikimodel.WikiParameters)
public void onHorizontalLine(WikiParameters params)
IWemListenerSimpleBlocks
onHorizontalLine
in interface IWemListenerSimpleBlocks
onHorizontalLine
in class PrintTextListener
params
- parameters of the horizontal lineIWemListenerSimpleBlocks.onHorizontalLine(WikiParameters
params)
public void onMacroBlock(String macroName, WikiParameters params, String content)
IWemListenerProgramming
onMacroBlock
in interface IWemListenerProgramming
onMacroBlock
in class PrintTextListener
macroName
- the name of the macroparams
- parameters of the macrocontent
- the content of the macropublic void onMacroInline(String macroName, WikiParameters params, String content)
IWemListenerProgramming
onMacroInline
in interface IWemListenerProgramming
onMacroInline
in class PrintTextListener
macroName
- the name of the macroparams
- parameters of the macrocontent
- the content of the macropublic void onTableCaption(String str)
IWemListenerTable
onTableCaption
in interface IWemListenerTable
onTableCaption
in class PrintTextListener
str
- the content of the table captionIWemListenerTable.onTableCaption(java.lang.String)
public void onVerbatimBlock(String str, WikiParameters params)
IWemListenerSimpleBlocks
onVerbatimBlock
in interface IWemListenerSimpleBlocks
onVerbatimBlock
in class PrintTextListener
str
- the content of the verbatim (pre-formatted) blockparams
- parameters of the verbatim blockIWemListenerSimpleBlocks.onVerbatimBlock(String,
WikiParameters)
Copyright © 2004–2021 XWiki. All rights reserved.