public class WrappingListener extends Object implements Listener
EMPTY_PARAMETERS
Constructor and Description |
---|
WrappingListener() |
Modifier and Type | Method and Description |
---|---|
void |
beginDefinitionDescription()
Start of a definition list description.
|
void |
beginDefinitionList(Map<String,String> parameters)
Start of a definition list.
|
void |
beginDefinitionTerm()
Start of a definition list term.
|
void |
beginDocument(MetaData metadata)
Start of the document.
|
void |
beginFigure(Map<String,String> parameters)
Start of a figure.
|
void |
beginFigureCaption(Map<String,String> parameters)
Start of a figure caption.
|
void |
beginFormat(Format format,
Map<String,String> parameters)
End of a text formatting block.
|
void |
beginGroup(Map<String,String> parameters)
Start a group of elements.
|
void |
beginHeader(HeaderLevel level,
String id,
Map<String,String> parameters)
Start of a header.
|
void |
beginLink(ResourceReference reference,
boolean freestanding,
Map<String,String> parameters)
Start of a link.
|
void |
beginList(ListType type,
Map<String,String> parameters)
Start of a list.
|
void |
beginListItem()
Start of a list item.
|
void |
beginListItem(Map<String,String> parameters)
Start of a list item.
|
void |
beginMacroMarker(String name,
Map<String,String> parameters,
String content,
boolean isInline)
Start of marker containing a macro definition.
|
void |
beginMetaData(MetaData metadata)
Start of MetaData (eg saving source from where the content is coming from).
|
void |
beginParagraph(Map<String,String> parameters)
Start of a paragraph.
|
void |
beginQuotation(Map<String,String> parameters)
Start of a quotation.
|
void |
beginQuotationLine()
Start of a quotation line.
|
void |
beginSection(Map<String,String> parameters)
Start of a section.
|
void |
beginTable(Map<String,String> parameters)
Start of a table.
|
void |
beginTableCell(Map<String,String> parameters)
Start of a table cell.
|
void |
beginTableHeadCell(Map<String,String> parameters)
Start of a table head cell.
|
void |
beginTableRow(Map<String,String> parameters)
Start of a table row.
|
void |
endDefinitionDescription()
End of a definition list description.
|
void |
endDefinitionList(Map<String,String> parameters)
End of a definition list.
|
void |
endDefinitionTerm()
End of a definition list term.
|
void |
endDocument(MetaData metadata)
End of the document.
|
void |
endFigure(Map<String,String> parameters)
End of a figure.
|
void |
endFigureCaption(Map<String,String> parameters)
End of a figure caption.
|
void |
endFormat(Format format,
Map<String,String> parameters)
End of a text formatting block.
|
void |
endGroup(Map<String,String> parameters)
End of the group.
|
void |
endHeader(HeaderLevel level,
String id,
Map<String,String> parameters)
End of a header.
|
void |
endLink(ResourceReference reference,
boolean freestanding,
Map<String,String> parameters)
End of a link.
|
void |
endList(ListType type,
Map<String,String> parameters)
End of a list.
|
void |
endListItem()
End of a list item.
|
void |
endListItem(Map<String,String> parameters)
End of a list item.
|
void |
endMacroMarker(String name,
Map<String,String> parameters,
String content,
boolean isInline)
End of marker containing a macro definition.
|
void |
endMetaData(MetaData metadata)
End of MetaData.
|
void |
endParagraph(Map<String,String> parameters)
End of a paragraph.
|
void |
endQuotation(Map<String,String> parameters)
End of a quotation.
|
void |
endQuotationLine()
End of a quotation line.
|
void |
endSection(Map<String,String> parameters)
End of a section.
|
void |
endTable(Map<String,String> parameters)
End of a table.
|
void |
endTableCell(Map<String,String> parameters)
End of a table cell.
|
void |
endTableHeadCell(Map<String,String> parameters)
End of a table head cell.
|
void |
endTableRow(Map<String,String> parameters)
End of a table row.
|
Listener |
getWrappedListener() |
void |
onEmptyLines(int count)
Represents an empty line between 2 standalone Blocks.
|
void |
onHorizontalLine(Map<String,String> parameters)
Represents an horizontal line.
|
void |
onId(String name)
A reference/location in a page.
|
void |
onImage(ResourceReference reference,
boolean freestanding,
Map<String,String> parameters)
An image.
|
void |
onMacro(String id,
Map<String,String> parameters,
String content,
boolean inline)
A Macro.
|
void |
onNewLine()
A new line or line break (it's up to the renderers to decide if it should be outputted as a new line or as a line
break in the given syntax).
|
void |
onRawText(String text,
Syntax syntax)
Some text to inject directly into the listener output without parsing it.
|
void |
onSpace()
A space.
|
void |
onSpecialSymbol(char symbol)
A special symbol (
* , < , > , = , quote, etc). |
void |
onVerbatim(String content,
boolean inline,
Map<String,String> parameters)
A portion of text.
|
void |
onWord(String word)
A word.
|
void |
setWrappedListener(Listener listener) |
public void setWrappedListener(Listener listener)
listener
- the Listener to wrappublic Listener getWrappedListener()
public void beginDocument(MetaData metadata)
Listener
beginDocument
in interface Listener
metadata
- the meta data to associate to the following events, see MetaData
public void beginFigure(Map<String,String> parameters)
Listener
beginFigure
in interface Listener
parameters
- a generic list of parameters for the figurepublic void beginFigureCaption(Map<String,String> parameters)
Listener
beginFigureCaption
in interface Listener
parameters
- a generic list of parameters for the figurepublic void endDocument(MetaData metadata)
Listener
endDocument
in interface Listener
metadata
- the meta data associated with the previous events, see MetaData
public void endFigure(Map<String,String> parameters)
Listener
public void endFigureCaption(Map<String,String> parameters)
Listener
endFigureCaption
in interface Listener
parameters
- a generic list of parameters for the figurepublic void beginGroup(Map<String,String> parameters)
Listener
beginGroup
in interface Listener
parameters
- a generic list of parameters. Example: style="background-color: blue"public void endGroup(Map<String,String> parameters)
Listener
public void beginFormat(Format format, Map<String,String> parameters)
Listener
beginFormat
in interface Listener
format
- the formatting type (bold, italic, etc)parameters
- a generic list of parameters. Example: style="background-color: blue"Format
public void beginList(ListType type, Map<String,String> parameters)
Listener
public void beginListItem()
Listener
beginListItem
in interface Listener
public void beginListItem(Map<String,String> parameters)
Listener
beginListItem
in interface Listener
parameters
- a generic list of parameters for the list item. Example: "style"/"background-color: blue"public void beginMacroMarker(String name, Map<String,String> parameters, String content, boolean isInline)
Listener
beginMacroMarker
in interface Listener
name
- the macro nameparameters
- the macro parameterscontent
- the macro contentisInline
- if true the macro is located in a inline content (like paragraph, etc.)Listener.onMacro(String, java.util.Map, String, boolean)
public void beginParagraph(Map<String,String> parameters)
Listener
beginParagraph
in interface Listener
parameters
- a generic list of parameters. Example: style="background-color: blue"public void beginSection(Map<String,String> parameters)
Listener
beginSection
in interface Listener
parameters
- a generic list of parameters. Example: style="background-color: blue"HeaderLevel
public void beginHeader(HeaderLevel level, String id, Map<String,String> parameters)
Listener
beginHeader
in interface Listener
level
- the header level (1, 2, 3, etc)id
- the header unique identifierparameters
- a generic list of parameters. Example: style="background-color: blue"HeaderLevel
public void endFormat(Format format, Map<String,String> parameters)
Listener
public void endList(ListType type, Map<String,String> parameters)
Listener
public void endListItem()
Listener
endListItem
in interface Listener
public void endListItem(Map<String,String> parameters)
Listener
endListItem
in interface Listener
parameters
- a generic list of parameters for the list item. Example: "style"/"background-color: blue"public void endMacroMarker(String name, Map<String,String> parameters, String content, boolean isInline)
Listener
endMacroMarker
in interface Listener
name
- the macro nameparameters
- the macro parameterscontent
- the macro contentisInline
- if true the macro is located in a inline content (like paragraph, etc.)Listener.beginMacroMarker(String, java.util.Map, String, boolean)
public void endParagraph(Map<String,String> parameters)
Listener
endParagraph
in interface Listener
parameters
- a generic list of parameters. Example: style="background-color: blue"public void endSection(Map<String,String> parameters)
Listener
endSection
in interface Listener
parameters
- a generic list of parameters. Example: style="background-color: blue"HeaderLevel
public void endHeader(HeaderLevel level, String id, Map<String,String> parameters)
Listener
endHeader
in interface Listener
level
- the header level (1, 2, 3, etc)id
- the header unique identifierparameters
- a generic list of parameters. Example: style="background-color: blue"HeaderLevel
public void beginLink(ResourceReference reference, boolean freestanding, Map<String,String> parameters)
LinkListener
beginLink
in interface LinkListener
reference
- the link referencefreestanding
- if true then the link is a free standing URI directly in the textparameters
- a generic list of parameters. Example: style="background-color: blue"ResourceReference
public void endLink(ResourceReference reference, boolean freestanding, Map<String,String> parameters)
LinkListener
endLink
in interface LinkListener
reference
- the link referencefreestanding
- if true then the link is a free standing URI directly in the textparameters
- a generic list of parameters. Example: style="background-color: blue"ResourceReference
public void onMacro(String id, Map<String,String> parameters, String content, boolean inline)
Listener
public void onNewLine()
Listener
public void onSpace()
Listener
public void onSpecialSymbol(char symbol)
Listener
*
, <
, >
, =
, quote, etc). Any non alpha numeric character is a
special symbol.onSpecialSymbol
in interface Listener
symbol
- the symbol encounteredpublic void onWord(String word)
Listener
public void onId(String name)
Listener
public void onHorizontalLine(Map<String,String> parameters)
Listener
onHorizontalLine
in interface Listener
parameters
- a generic list of parameters. Example: style="background-color: blue"public void onEmptyLines(int count)
Listener
onEmptyLines
in interface Listener
count
- the number of empty lines between 2 standalone Blockspublic void onVerbatim(String content, boolean inline, Map<String,String> parameters)
Listener
onVerbatim
in interface Listener
content
- the string to protected from renderinginline
- if true the text content is located in a inline content (like paragraph, etc.)parameters
- a generic list of parameters. Example: style="background-color: blue"public void onRawText(String text, Syntax syntax)
Listener
public void beginDefinitionList(Map<String,String> parameters)
Listener
beginDefinitionList
in interface Listener
parameters
- a generic list of parameters for the list. Example: "style"/"background-color: blue"public void endDefinitionList(Map<String,String> parameters)
Listener
endDefinitionList
in interface Listener
parameters
- a generic list of parameters for the list. Example: "style"/"background-color: blue"public void beginDefinitionTerm()
Listener
beginDefinitionTerm
in interface Listener
public void beginDefinitionDescription()
Listener
beginDefinitionDescription
in interface Listener
public void endDefinitionTerm()
Listener
endDefinitionTerm
in interface Listener
public void endDefinitionDescription()
Listener
endDefinitionDescription
in interface Listener
public void beginQuotation(Map<String,String> parameters)
Listener
beginQuotation
in interface Listener
parameters
- a generic list of parameters for the quotation. Example: "style"/"background-color: blue"public void endQuotation(Map<String,String> parameters)
Listener
endQuotation
in interface Listener
parameters
- a generic list of parameters for the quotation. Example: "style"/"background-color: blue"public void beginQuotationLine()
Listener
beginQuotationLine
in interface Listener
public void endQuotationLine()
Listener
endQuotationLine
in interface Listener
public void beginTable(Map<String,String> parameters)
Listener
beginTable
in interface Listener
parameters
- a generic list of parameters for the table.public void beginTableCell(Map<String,String> parameters)
Listener
beginTableCell
in interface Listener
parameters
- a generic list of parameters for the table cell.public void beginTableHeadCell(Map<String,String> parameters)
Listener
beginTableHeadCell
in interface Listener
parameters
- a generic list of parameters for the table head cell.public void beginTableRow(Map<String,String> parameters)
Listener
beginTableRow
in interface Listener
parameters
- a generic list of parameters for the table row.public void endTable(Map<String,String> parameters)
Listener
public void endTableCell(Map<String,String> parameters)
Listener
endTableCell
in interface Listener
parameters
- a generic list of parameters for the table cell.public void endTableHeadCell(Map<String,String> parameters)
Listener
endTableHeadCell
in interface Listener
parameters
- a generic list of parameters for the table head cell.public void endTableRow(Map<String,String> parameters)
Listener
endTableRow
in interface Listener
parameters
- a generic list of parameters for the table row.public void onImage(ResourceReference reference, boolean freestanding, Map<String,String> parameters)
ImageListener
onImage
in interface ImageListener
reference
- the image referencefreestanding
- if true then the image is defined directly as a URI in the textparameters
- a generic list of parameters. Example: style="background-color: blue"public void beginMetaData(MetaData metadata)
Listener
beginMetaData
in interface Listener
metadata
- the metadatapublic void endMetaData(MetaData metadata)
Listener
endMetaData
in interface Listener
metadata
- the metadataCopyright © 2004–2021 XWiki. All rights reserved.