|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xwiki.rendering.wikimodel.AgregatingWemListener
public class AgregatingWemListener
Field Summary | |
---|---|
protected IWemListenerSimpleBlocks |
fBlockListener
|
protected IWemListenerDocument |
fDocumentListener
|
protected IWemListenerInline |
fInlineListener
|
protected IWemListenerList |
fListListener
|
protected IWemListenerProgramming |
fProgrammingListener
|
protected IWemListenerSemantic |
fSemanticListener
|
protected IWemListenerTable |
fTableListener
|
Constructor Summary | |
---|---|
AgregatingWemListener()
|
Method Summary | |
---|---|
void |
beginDefinitionDescription()
This method is used to notify about a definition description. |
void |
beginDefinitionList(WikiParameters params)
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 |
beginFormat(WikiFormat format)
This method is called at the beginning of a sequence of in-line elements having the specified formatting parameters. |
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 params,
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 |
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 |
beginPropertyInline(String propertyUri)
This method is called to notify about the beginning of a new inline property found in the text of the parsed document. |
void |
beginQuotation(WikiParameters params)
Notifies about the beginning of a quotation elements. |
void |
beginQuotationLine()
A list containing quotation. |
void |
beginSection(int docLevel,
int headerLevel,
WikiParameters params)
This method is used to notify about the beginning of a section. |
void |
beginSectionContent(int docLevel,
int headerLevel,
WikiParameters params)
This method is used to notify about the beginning of a section. |
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 params)
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 |
endFormat(WikiFormat format)
This method is called to notify about the end of a sequence of in-line elements having common formatting parameters. |
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 params,
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 |
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 |
endPropertyInline(String propertyUri)
This method is called to notify about the end of an inline property found in the text of 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 |
endSection(int docLevel,
int headerLevel,
WikiParameters params)
This method is used to notify about the end of a document section. |
void |
endSectionContent(int docLevel,
int headerLevel,
WikiParameters params)
This method is used to notify about the end of a document section. |
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. |
IWemListenerSimpleBlocks |
getBlockListener()
|
IWemListenerDocument |
getDocumentListener()
|
IWemListenerInline |
getInlineListener()
|
IWemListenerList |
getListListener()
|
IWemListenerProgramming |
getProgrammingListener()
|
IWemListenerSemantic |
getSemanticListener()
|
IWemListenerTable |
getTableListener()
|
void |
onEmptyLines(int count)
This method is used to notify about a sequence of empty lines. |
void |
onEscape(String str)
Escaped symbols. |
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 |
onExtensionInline(String extensionName,
WikiParameters params)
This method is used to notify about a new extension which CAN generate in-line elements as a result of its interpretation. |
void |
onHorizontalLine(WikiParameters params)
This method notifies horizontal lines defined in the text. |
void |
onImage(String ref)
This method is called to notify that an free standing image was found in the parsed wiki document. |
void |
onImage(WikiReference ref)
This method is called to notify that a structured reference was found in the text |
void |
onLineBreak()
This method is called to notify about a forced line break found 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 |
onNewLine()
This method is called to notify that the parsed block contains a new line sequence ("\r\n" or "\r" or "\n" character sequence). |
void |
onReference(String ref)
This method is called to notify that an URI (an implicit reference) was found in the parsed wiki document. |
void |
onReference(WikiReference ref)
This method is called to notify that a structured reference was found in the text |
void |
onSpace(String str)
This method is called to notify about a sequence of space symbols (like " " or "\t" symbols). |
void |
onSpecialSymbol(String str)
This method is called to notify about a sequence of special characters. |
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 |
void |
onVerbatimInline(String str,
WikiParameters params)
This method is called to notify about not-interpreted in-line sequence of characters which should be represented in the final text "as is". |
void |
onWord(String str)
This method is called to notify about a "word" found in the document. |
void |
setBlockListener(IWemListenerSimpleBlocks blockListener)
|
void |
setDocumentListener(IWemListenerDocument documentListener)
|
void |
setInlineListener(IWemListenerInline inlineListener)
|
void |
setListListener(IWemListenerList listListener)
|
void |
setProgrammingListener(IWemListenerProgramming programmingListener)
|
void |
setSemanticListener(IWemListenerSemantic semanticListener)
|
void |
setTableListener(IWemListenerTable tableListener)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected IWemListenerSimpleBlocks fBlockListener
protected IWemListenerDocument fDocumentListener
protected IWemListenerInline fInlineListener
protected IWemListenerList fListListener
protected IWemListenerProgramming fProgrammingListener
protected IWemListenerSemantic fSemanticListener
protected IWemListenerTable fTableListener
Constructor Detail |
---|
public AgregatingWemListener()
Method Detail |
---|
public void beginDefinitionDescription()
IWemListenerList
beginDefinitionDescription
in interface IWemListenerList
IWemListenerList.beginDefinitionDescription()
public void beginDefinitionList(WikiParameters params)
IWemListenerList
beginDefinitionList
in interface IWemListenerList
params
- list of parameters for the listIWemListenerList.beginDefinitionList(WikiParameters)
public void beginDefinitionTerm()
IWemListenerList
beginDefinitionTerm
in interface IWemListenerList
IWemListenerList.beginDefinitionTerm()
public void beginDocument(WikiParameters params)
IWemListenerDocument
beginDocument
in interface IWemListenerDocument
IWemListenerDocument.beginDocument(WikiParameters)
public void beginFormat(WikiFormat format)
IWemListenerInline
beginFormat
in interface IWemListenerInline
format
- the object defining formatting parameters of in-line
elements.IWemListenerInline.beginFormat(WikiFormat)
public void beginHeader(int headerLevel, WikiParameters params)
IWemListenerDocument
beginHeader
in interface IWemListenerDocument
headerLevel
- the level of the found header; valid values: 1-6params
- wiki parameters associated with theIWemListenerDocument.beginHeader(int,
WikiParameters)
public void beginInfoBlock(String infoType, WikiParameters params)
IWemListenerSimpleBlocks
beginInfoBlock
in interface IWemListenerSimpleBlocks
infoType
- the "type" of the special blockparams
- parameters of this blockIWemListenerSimpleBlocks.beginInfoBlock(java.lang.String,
WikiParameters)
public void beginList(WikiParameters params, 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
params
- 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
IWemListenerList.beginListItem()
public void beginParagraph(WikiParameters params)
IWemListenerSimpleBlocks
beginParagraph
in interface IWemListenerSimpleBlocks
params
- paragraph parametersIWemListenerSimpleBlocks.beginParagraph(WikiParameters)
public void beginPropertyBlock(String propertyUri, boolean doc)
IWemListenerSemantic
beginPropertyBlock
in interface IWemListenerSemantic
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 beginPropertyInline(String propertyUri)
IWemListenerSemantic
beginPropertyInline
in interface IWemListenerSemantic
propertyUri
- the URI of the semantic inline property found in the
documentIWemListenerSemantic.beginPropertyInline(java.lang.String)
public void beginQuotation(WikiParameters params)
IWemListenerList
beginQuotation
in interface IWemListenerList
params
- parameters of the listIWemListenerList.beginQuotation(WikiParameters)
public void beginQuotationLine()
IWemListenerList
beginQuotationLine
in interface IWemListenerList
IWemListenerList.beginQuotationLine()
public void beginSection(int docLevel, int headerLevel, WikiParameters params)
IWemListenerDocument
beginSection
in interface IWemListenerDocument
docLevel
- the level (depth) of the document containing this sectionheaderLevel
- the level of the header defining this sectionparams
- parameters parameters of the document or the headerIWemListenerDocument.beginSection(int, int,
WikiParameters)
public void beginSectionContent(int docLevel, int headerLevel, WikiParameters params)
IWemListenerDocument
beginSectionContent
in interface IWemListenerDocument
docLevel
- the level (depth) of the document containing this sectionheaderLevel
- the level of the header defining this sectionparams
- parameters parameters of the document or the headerIWemListenerDocument.beginSectionContent(int, int,
WikiParameters)
public void beginTable(WikiParameters params)
IWemListenerTable
beginTable
in interface IWemListenerTable
params
- table parametersIWemListenerTable.beginTable(WikiParameters)
public void beginTableCell(boolean tableHead, WikiParameters params)
IWemListenerTable
beginTableCell
in interface IWemListenerTable
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
params
- parameters of the row.IWemListenerTable.beginTableRow(WikiParameters)
public void endDefinitionDescription()
IWemListenerList
endDefinitionDescription
in interface IWemListenerList
IWemListenerList.endDefinitionDescription()
public void endDefinitionList(WikiParameters params)
IWemListenerList
endDefinitionList
in interface IWemListenerList
params
- list of parameters for the listIWemListenerList.endDefinitionList(WikiParameters)
public void endDefinitionTerm()
IWemListenerList
endDefinitionTerm
in interface IWemListenerList
IWemListenerList.endDefinitionTerm()
public void endDocument(WikiParameters params)
IWemListenerDocument
endDocument
in interface IWemListenerDocument
IWemListenerDocument.endDocument(WikiParameters)
public void endFormat(WikiFormat format)
IWemListenerInline
endFormat
in interface IWemListenerInline
format
- the formatting object defining how contained in-line
elements should be formattedIWemListenerInline.endFormat(WikiFormat)
public void endHeader(int headerLevel, WikiParameters params)
IWemListenerDocument
endHeader
in interface IWemListenerDocument
headerLevel
- the level of the headerparams
- wiki parameters of the headerIWemListenerDocument.endHeader(int,
WikiParameters)
public void endInfoBlock(String infoType, WikiParameters params)
IWemListenerSimpleBlocks
endInfoBlock
in interface IWemListenerSimpleBlocks
infoType
- the "type" of the special blockparams
- parameters of this blockIWemListenerSimpleBlocks.endInfoBlock(java.lang.String,
WikiParameters)
public void endList(WikiParameters params, boolean ordered)
IWemListenerList
endList
in interface IWemListenerList
params
- 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
IWemListenerList.endListItem()
public void endParagraph(WikiParameters params)
IWemListenerSimpleBlocks
endParagraph
in interface IWemListenerSimpleBlocks
params
- paragraph parametersIWemListenerSimpleBlocks.endParagraph(WikiParameters)
public void endPropertyBlock(String propertyUri, boolean doc)
IWemListenerSemantic
endPropertyBlock
in interface IWemListenerSemantic
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 endPropertyInline(String propertyUri)
IWemListenerSemantic
endPropertyInline
in interface IWemListenerSemantic
propertyUri
- the URI of the semantic inline property found in the
documentIWemListenerSemantic.endPropertyInline(java.lang.String)
public void endQuotation(WikiParameters params)
IWemListenerList
endQuotation
in interface IWemListenerList
params
- parameters of the listIWemListenerList.endQuotation(WikiParameters)
public void endQuotationLine()
IWemListenerList
endQuotationLine
in interface IWemListenerList
IWemListenerList.endQuotationLine()
public void endSection(int docLevel, int headerLevel, WikiParameters params)
IWemListenerDocument
endSection
in interface IWemListenerDocument
docLevel
- the level (depth) of the document containing this sectionheaderLevel
- the level of the header defining this sectionparams
- parameters parameters of the document or the headerIWemListenerDocument.endSection(int, int,
WikiParameters)
public void endSectionContent(int docLevel, int headerLevel, WikiParameters params)
IWemListenerDocument
endSectionContent
in interface IWemListenerDocument
docLevel
- the level (depth) of the document containing this sectionheaderLevel
- the level of the header defining this sectionparams
- parameters parameters of the document or the headerIWemListenerDocument.endSectionContent(int, int,
WikiParameters)
public void endTable(WikiParameters params)
IWemListenerTable
endTable
in interface IWemListenerTable
params
- table parametersIWemListenerTable.endTable(WikiParameters)
public void endTableCell(boolean tableHead, WikiParameters params)
IWemListenerTable
endTableCell
in interface IWemListenerTable
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
params
- parameters of the row.IWemListenerTable.endTableRow(WikiParameters)
public IWemListenerSimpleBlocks getBlockListener()
public IWemListenerDocument getDocumentListener()
public IWemListenerInline getInlineListener()
public IWemListenerList getListListener()
public IWemListenerProgramming getProgrammingListener()
public IWemListenerSemantic getSemanticListener()
public IWemListenerTable getTableListener()
public void onEmptyLines(int count)
IWemListenerSimpleBlocks
onEmptyLines
in interface IWemListenerSimpleBlocks
count
- the number of empty lines found in the textIWemListenerSimpleBlocks.onEmptyLines(int)
public void onEscape(String str)
IWemListenerInline
onEscape
in interface IWemListenerInline
str
- the escaped sequence of charactersIWemListenerInline.onEscape(java.lang.String)
public void onExtensionBlock(String extensionName, WikiParameters params)
IWemListenerProgramming
onExtensionBlock
in interface IWemListenerProgramming
extensionName
- the name of the extensionparams
- parameters for the extensionIWemListenerProgramming.onExtensionBlock(java.lang.String,
WikiParameters)
public void onExtensionInline(String extensionName, WikiParameters params)
IWemListenerProgramming
onExtensionInline
in interface IWemListenerProgramming
extensionName
- the name of the extensionparams
- parameters for the extensionIWemListenerProgramming.onExtensionInline(java.lang.String,
WikiParameters)
public void onHorizontalLine(WikiParameters params)
IWemListenerSimpleBlocks
onHorizontalLine
in interface IWemListenerSimpleBlocks
params
- parameters of the horizontal lineIWemListenerSimpleBlocks.onHorizontalLine(WikiParameters)
public void onImage(String ref)
IWemListenerInline
onImage
in interface IWemListenerInline
ref
- the reference the referenceIWemListenerInline.onImage(java.lang.String)
public void onImage(WikiReference ref)
IWemListenerInline
onImage
in interface IWemListenerInline
ref
- the reference the referenceIWemListenerInline.onImage(WikiReference)
public void onLineBreak()
IWemListenerInline
IWemListenerInline.onNewLine()
notification.
onLineBreak
in interface IWemListenerInline
IWemListenerInline.onLineBreak()
public void onMacroBlock(String macroName, WikiParameters params, String content)
IWemListenerProgramming
onMacroBlock
in interface IWemListenerProgramming
macroName
- the name of the macroparams
- parameters of the macrocontent
- the content of the macroIWemListenerProgramming.onMacroBlock(java.lang.String,
WikiParameters, java.lang.String)
public void onMacroInline(String macroName, WikiParameters params, String content)
IWemListenerProgramming
onMacroInline
in interface IWemListenerProgramming
macroName
- the name of the macroparams
- parameters of the macrocontent
- the content of the macroIWemListenerProgramming.onMacroInline(java.lang.String,
WikiParameters, java.lang.String)
public void onNewLine()
IWemListenerInline
IWemListenerInline.onLineBreak()
event.
onNewLine
in interface IWemListenerInline
IWemListenerInline.onNewLine()
public void onReference(String ref)
IWemListenerInline
onReference
in interface IWemListenerInline
ref
- the URIIWemListenerInline.onReference(java.lang.String)
public void onReference(WikiReference ref)
IWemListenerInline
onReference
in interface IWemListenerInline
ref
- the reference the referenceIWemListenerInline.onReference(WikiReference)
public void onSpace(String str)
IWemListenerInline
onSpace
in interface IWemListenerInline
str
- the sequence of space charactersIWemListenerInline.onSpace(java.lang.String)
public void onSpecialSymbol(String str)
IWemListenerInline
The full list of possible special symbols: "!", "\"", "#", "$", "%", "&", "'", "(", ")", "*", "+", ",", "-", ".", "/", ":", ";", "<", "=", ">", "?", "@", "[", "\\", "]", "^", "_", "`", "{", "|", "}", "~"
onSpecialSymbol
in interface IWemListenerInline
str
- the sequence of special symbolsIWemListenerInline.onSpecialSymbol(java.lang.String)
public void onTableCaption(String str)
IWemListenerTable
onTableCaption
in interface IWemListenerTable
str
- the content of the table captionIWemListenerTable.onTableCaption(java.lang.String)
public void onVerbatimBlock(String str, WikiParameters params)
IWemListenerSimpleBlocks
onVerbatimBlock
in interface IWemListenerSimpleBlocks
str
- the content of the verbatim (pre-formatted) blockparams
- parameters of the verbatim blockIWemListenerSimpleBlocks.onVerbatimBlock(java.lang.String,
WikiParameters)
public void onVerbatimInline(String str, WikiParameters params)
IWemListenerInline
onVerbatimInline
in interface IWemListenerInline
str
- the sequence of non-interpreted charactersparams
- TODOIWemListenerInline.onVerbatimInline(java.lang.String,
WikiParameters)
public void onWord(String str)
IWemListenerInline
Words are formed by the all characters excluding the following ones: "\t", "\n", "\r", " ", "!", "\"", "#", "$", "%", "&", "'", "(", ")", "*", "+", ",", "-", ".", "/", ":", ";", "<", "=", ">", "?", "@", "[", "\\", "]", "^", "_", "`", "{", "|", "}", "~"
onWord
in interface IWemListenerInline
str
- the sequence of characters forming a wordIWemListenerInline.onWord(java.lang.String)
public void setBlockListener(IWemListenerSimpleBlocks blockListener)
blockListener
- the blockListener to setpublic void setDocumentListener(IWemListenerDocument documentListener)
documentListener
- the documentListener to setpublic void setInlineListener(IWemListenerInline inlineListener)
inlineListener
- the inlineListener to setpublic void setListListener(IWemListenerList listListener)
listListener
- the listListener to setpublic void setProgrammingListener(IWemListenerProgramming programmingListener)
programmingListener
- the programmingListener to setpublic void setSemanticListener(IWemListenerSemantic semanticListener)
semanticListener
- the semanticListener to setpublic void setTableListener(IWemListenerTable tableListener)
tableListener
- the tableListener to set
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |