org.xwiki.rendering.listener.chaining
Class BlockStateChainingListener

java.lang.Object
  org.xwiki.rendering.listener.chaining.AbstractChainingListener
      org.xwiki.rendering.listener.chaining.BlockStateChainingListener

All Implemented Interfaces:

ChainingListener, StackableChainingListener, ImageListener, LinkListener, Listener

public class BlockStateChainingListener
extends AbstractChainingListener
implements StackableChainingListener

Indicates block element for which we are inside and previous blocks.

Since:

1.8RC1

Version:

$Id: b91808752c3a57d873c18d9562a9664ebc92b817 $

Nested Class Summary

static class

BlockStateChainingListener.Event

Field Summary

Fields inherited from interface org.xwiki.rendering.listener.Listener

EMPTY_PARAMETERS

Constructor Summary

BlockStateChainingListener(ListenerChain listenerChain)

Method Summary

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	beginHeader(HeaderLevel level, String id, Map<String,String> parameters) Start of a header.
void	beginLink(ResourceReference reference, boolean isFreeStandingURI, Map<String,String> parameters) Start of a link.
void	beginList(ListType listType, Map<String,String> parameters) Start of a list.
void	beginListItem() 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	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	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.
StackableChainingListener	createChainingListenerInstance()
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	endFormat(Format format, Map<String,String> parameters) End of a text formatting block.
void	endHeader(HeaderLevel level, String id, Map<String,String> parameters) End of a header.
void	endLink(ResourceReference reference, boolean isFreeStandingURI, Map<String,String> parameters) End of a link.
void	endList(ListType listType, Map<String,String> parameters) End of a list.
void	endListItem() 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	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.
int	getCellCol()
int	getCellRow()
int	getDefinitionListDepth()
int	getDefinitionListItemIndex()
int	getInlineDepth()
int	getLinkDepth()
int	getListDepth()
int	getListItemIndex()
int	getMacroDepth()
BlockStateChainingListener.Event	getPreviousEvent()
int	getQuotationDepth()
int	getQuotationLineDepth()
int	getQuotationLineIndex()
boolean	isInDefinitionList()
boolean	isInHeader()
boolean	isInLine()
boolean	isInLink()
boolean	isInList()
boolean	isInMacro()
boolean	isInParagraph()
boolean	isInQuotation()
boolean	isInQuotationLine()
boolean	isInTable()
boolean	isInTableCell()
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 isFreeStandingURI, Map<String,String> parameters) An image.
void	onMacro(String id, Map<String,String> parameters, String content, boolean isInline) 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 protectedString, boolean isInline, Map<String,String> parameters) A portion of text.
void	onWord(String word) A word.
void	popLinkDepth()
void	pushLinkDepth()

Methods inherited from class org.xwiki.rendering.listener.chaining.AbstractChainingListener

beginDocument, beginFormat, beginGroup, beginMetaData, beginSection, endGroup, endMetaData, 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.chaining.ChainingListener

getListenerChain

Methods inherited from interface org.xwiki.rendering.listener.Listener

beginDocument, beginFormat, beginGroup, beginMetaData, beginSection, endGroup, endMetaData

Constructor Detail

BlockStateChainingListener

public BlockStateChainingListener(ListenerChain listenerChain)

Method Detail

createChainingListenerInstance

public StackableChainingListener createChainingListenerInstance()

Specified by:

createChainingListenerInstance in interface StackableChainingListener

Returns:

the new instance of the listener

getPreviousEvent

public BlockStateChainingListener.Event getPreviousEvent()

getInlineDepth

public int getInlineDepth()

isInLine

public boolean isInLine()

isInParagraph

public boolean isInParagraph()

isInHeader

public boolean isInHeader()

isInTable

public boolean isInTable()

isInTableCell

public boolean isInTableCell()

getCellCol

public int getCellCol()

getCellRow

public int getCellRow()

getDefinitionListDepth

public int getDefinitionListDepth()

isInDefinitionList

public boolean isInDefinitionList()

getDefinitionListItemIndex

public int getDefinitionListItemIndex()

getListDepth

public int getListDepth()

isInList

public boolean isInList()

getListItemIndex

public int getListItemIndex()

pushLinkDepth

public void pushLinkDepth()

popLinkDepth

public void popLinkDepth()

getLinkDepth

public int getLinkDepth()

isInLink

public boolean isInLink()

getQuotationDepth

public int getQuotationDepth()

isInQuotation

public boolean isInQuotation()

getQuotationLineDepth

public int getQuotationLineDepth()

isInQuotationLine

public boolean isInQuotationLine()

getQuotationLineIndex

public int getQuotationLineIndex()

getMacroDepth

public int getMacroDepth()

isInMacro

public boolean isInMacro()

beginDefinitionDescription

public void beginDefinitionDescription()

Description copied from interface: Listener

Start of a definition list description. For example in HTML this is the equivalent of <dd>.

Specified by:

beginDefinitionDescription in interface Listener

Overrides:

beginDefinitionDescription in class AbstractChainingListener

beginDefinitionList

public void beginDefinitionList(Map<String,String> parameters)

Start of a definition list. For example in HTML this is the equivalent of <dl>.

Specified by:

beginDefinitionList in interface Listener

Overrides:

beginDefinitionList in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters for the list. Example: "style"/"background-color: blue"

Since:

2.0RC1

beginDefinitionTerm

public void beginDefinitionTerm()

Description copied from interface: Listener

Start of a definition list term. For example in HTML this is the equivalent of <dt>.

Specified by:

beginDefinitionTerm in interface Listener

Overrides:

beginDefinitionTerm in class AbstractChainingListener

beginLink

public void beginLink(ResourceReference reference,
                      boolean isFreeStandingURI,
                      Map<String,String> parameters)

Start of a link.

Specified by:

beginLink in interface LinkListener

Overrides:

beginLink in class AbstractChainingListener

Parameters:

reference - the link reference

isFreeStandingURI - if true then the link is a free standing URI directly in the text

parameters - a generic list of parameters. Example: style="background-color: blue"

Since:

2.5RC1

See Also:

ResourceReference

beginList

public void beginList(ListType listType,
                      Map<String,String> parameters)

Description copied from interface: Listener

Start of a list.

Specified by:

beginList in interface Listener

Overrides:

beginList in class AbstractChainingListener

Parameters:

listType - the type of list (bulleted, numbered, etc)

parameters - a generic list of parameters for the list. Example: "style"/"background-color: blue"

See Also:

ListType

beginListItem

public void beginListItem()

Description copied from interface: Listener

Start of a list item.

Specified by:

beginListItem in interface Listener

Overrides:

beginListItem in class AbstractChainingListener

beginMacroMarker

public void beginMacroMarker(String name,
                             Map<String,String> parameters,
                             String content,
                             boolean isInline)

Description copied from interface: Listener

Start of marker containing a macro definition. This is a special that Macro Blocks emits when they are executed so that it's possible to reconstruct the initial macro syntax even after Macros have been executed. This is used for exemple by the WYSIWYG editor to let use see the result of executing a macro and still let them modify the macro definition.

Specified by:

beginMacroMarker in interface Listener

Overrides:

beginMacroMarker in class AbstractChainingListener

Parameters:

name - the macro name

parameters - the macro parameters

content - the macro content

isInline - if true the macro is located in a inline content (like paragraph, etc.)

See Also:

Listener.onMacro(String, java.util.Map, String, boolean)

beginParagraph

public void beginParagraph(Map<String,String> parameters)

Description copied from interface: Listener

Start of a paragraph.

Specified by:

beginParagraph in interface Listener

Overrides:

beginParagraph in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters. Example: style="background-color: blue"

beginQuotation

public void beginQuotation(Map<String,String> parameters)

Description copied from interface: Listener

Start of a quotation. There are one or several quotation lines inside a quotation block.

Specified by:

beginQuotation in interface Listener

Overrides:

beginQuotation in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters for the quotation. Example: "style"/"background-color: blue"

beginQuotationLine

public void beginQuotationLine()

Description copied from interface: Listener

Start of a quotation line. There can be several quotation lines in a quotation block.

Specified by:

beginQuotationLine in interface Listener

Overrides:

beginQuotationLine in class AbstractChainingListener

beginHeader

public void beginHeader(HeaderLevel level,
                        String id,
                        Map<String,String> parameters)

Description copied from interface: Listener

Start of a header.

Specified by:

beginHeader in interface Listener

Overrides:

beginHeader in class AbstractChainingListener

Parameters:

level - the header level (1, 2, 3, etc)

id - the header unique identifier

parameters - a generic list of parameters. Example: style="background-color: blue"

See Also:

HeaderLevel

beginTable

public void beginTable(Map<String,String> parameters)

Description copied from interface: Listener

Start of a table.

Specified by:

beginTable in interface Listener

Overrides:

beginTable in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters for the table.

beginTableRow

public void beginTableRow(Map<String,String> parameters)

Description copied from interface: Listener

Start of a table row.

Specified by:

beginTableRow in interface Listener

Overrides:

beginTableRow in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters for the table row.

beginTableCell

public void beginTableCell(Map<String,String> parameters)

Description copied from interface: Listener

Start of a table cell.

Specified by:

beginTableCell in interface Listener

Overrides:

beginTableCell in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters for the table cell.

beginTableHeadCell

public void beginTableHeadCell(Map<String,String> parameters)

Description copied from interface: Listener

Start of a table head cell.

Specified by:

beginTableHeadCell in interface Listener

Overrides:

beginTableHeadCell in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters for the table head cell.

endDefinitionDescription

public void endDefinitionDescription()

Description copied from interface: Listener

End of a definition list description. For example in HTML this is the equivalent of </dd>.

Specified by:

endDefinitionDescription in interface Listener

Overrides:

endDefinitionDescription in class AbstractChainingListener

endDefinitionList

public void endDefinitionList(Map<String,String> parameters)

End of a definition list. For example in HTML this is the equivalent of </dl>.

Specified by:

endDefinitionList in interface Listener

Overrides:

endDefinitionList in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters for the list. Example: "style"/"background-color: blue"

Since:

2.0RC1

endDefinitionTerm

public void endDefinitionTerm()

Description copied from interface: Listener

End of a definition list term. For example in HTML this is the equivalent of </dt>.

Specified by:

endDefinitionTerm in interface Listener

Overrides:

endDefinitionTerm in class AbstractChainingListener

endDocument

public void endDocument(MetaData metaData)

End of the document.

Specified by:

endDocument in interface Listener

Overrides:

endDocument in class AbstractChainingListener

Parameters:

metaData - the meta data associated with the previous events, see MetaData

Since:

3.0M2

endFormat

public void endFormat(Format format,
                      Map<String,String> parameters)

Description copied from interface: Listener

End of a text formatting block.

Specified by:

endFormat in interface Listener

Overrides:

endFormat in class AbstractChainingListener

Parameters:

format - the formatting type (bold, italic, etc)

parameters - a generic list of parameters. Example: style="background-color: blue"

See Also:

Format

endLink

public void endLink(ResourceReference reference,
                    boolean isFreeStandingURI,
                    Map<String,String> parameters)

End of a link.

Specified by:

endLink in interface LinkListener

Overrides:

endLink in class AbstractChainingListener

Parameters:

reference - the link reference

isFreeStandingURI - if true then the link is a free standing URI directly in the text

parameters - a generic list of parameters. Example: style="background-color: blue"

Since:

2.5RC1

See Also:

ResourceReference

endList

public void endList(ListType listType,
                    Map<String,String> parameters)

Description copied from interface: Listener

End of a list.

Specified by:

endList in interface Listener

Overrides:

endList in class AbstractChainingListener

Parameters:

listType - the type of list (bulleted, numbered, etc)

parameters - a generic list of parameters for the list. Example: "style"/"background-color: blue"

See Also:

ListType

endListItem

public void endListItem()

Description copied from interface: Listener

End of a list item.

Specified by:

endListItem in interface Listener

Overrides:

endListItem in class AbstractChainingListener

endMacroMarker

public void endMacroMarker(String name,
                           Map<String,String> parameters,
                           String content,
                           boolean isInline)

Description copied from interface: Listener

End of marker containing a macro definition.

Specified by:

endMacroMarker in interface Listener

Overrides:

endMacroMarker in class AbstractChainingListener

Parameters:

name - the macro name

parameters - the macro parameters

content - the macro content

isInline - if true the macro is located in a inline content (like paragraph, etc.)

See Also:

Listener.beginMacroMarker(String, java.util.Map, String, boolean)

endParagraph

public void endParagraph(Map<String,String> parameters)

Description copied from interface: Listener

End of a paragraph.

Specified by:

endParagraph in interface Listener

Overrides:

endParagraph in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters. Example: style="background-color: blue"

endQuotation

public void endQuotation(Map<String,String> parameters)

Description copied from interface: Listener

End of a quotation.

Specified by:

endQuotation in interface Listener

Overrides:

endQuotation in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters for the quotation. Example: "style"/"background-color: blue"

endQuotationLine

public void endQuotationLine()

Description copied from interface: Listener

End of a quotation line.

Specified by:

endQuotationLine in interface Listener

Overrides:

endQuotationLine in class AbstractChainingListener

endSection

public void endSection(Map<String,String> parameters)

Description copied from interface: Listener

End of a section.

Specified by:

endSection in interface Listener

Overrides:

endSection in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters. Example: style="background-color: blue"

See Also:

HeaderLevel

endHeader

public void endHeader(HeaderLevel level,
                      String id,
                      Map<String,String> parameters)

Description copied from interface: Listener

End of a header.

Specified by:

endHeader in interface Listener

Overrides:

endHeader in class AbstractChainingListener

Parameters:

level - the header level (1, 2, 3, etc)

id - the header unique identifier

parameters - a generic list of parameters. Example: style="background-color: blue"

See Also:

HeaderLevel

endTable

public void endTable(Map<String,String> parameters)

Description copied from interface: Listener

End of a table.

Specified by:

endTable in interface Listener

Overrides:

endTable in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters for the table.

endTableCell

public void endTableCell(Map<String,String> parameters)

Description copied from interface: Listener

End of a table cell.

Specified by:

endTableCell in interface Listener

Overrides:

endTableCell in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters for the table cell.

endTableHeadCell

public void endTableHeadCell(Map<String,String> parameters)

Description copied from interface: Listener

End of a table head cell.

Specified by:

endTableHeadCell in interface Listener

Overrides:

endTableHeadCell in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters for the table head cell.

endTableRow

public void endTableRow(Map<String,String> parameters)

Description copied from interface: Listener

End of a table row.

Specified by:

endTableRow in interface Listener

Overrides:

endTableRow in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters for the table row.

onRawText

public void onRawText(String text,
                      Syntax syntax)

Description copied from interface: Listener

Some text to inject directly into the listener output without parsing it. For example a HTML macro could inject directly some HTML entered by the user into the rendered HTML output. Note that it's not recommended to use this event in most cases since it can lead to invalid content being generated and in addition most listener implementations will not understand the injected text and will just ignore it.

Specified by:

onRawText in interface Listener

Overrides:

onRawText in class AbstractChainingListener

Parameters:

text - the text to inject

syntax - the syntax in which the text is written. This is useful so that listener implementations can decide whether they can handle direct inject for that syntax

onEmptyLines

public void onEmptyLines(int count)

Description copied from interface: Listener

Represents an empty line between 2 standalone Blocks. A standalone block is block that is not included in another block. Standalone blocks are Paragraph, Standalone Macro, Lists, Table, etc.

Specified by:

onEmptyLines in interface Listener

Overrides:

onEmptyLines in class AbstractChainingListener

Parameters:

count - the number of empty lines between 2 standalone Blocks

onHorizontalLine

public void onHorizontalLine(Map<String,String> parameters)

Description copied from interface: Listener

Represents an horizontal line.

Specified by:

onHorizontalLine in interface Listener

Overrides:

onHorizontalLine in class AbstractChainingListener

Parameters:

parameters - a generic list of parameters. Example: style="background-color: blue"

onId

public void onId(String name)

Description copied from interface: Listener

A reference/location in a page. In HTML for example this is called an Anchor. It allows pointing to that location, for example in links. Note that there is no wiki syntax for this in general and it's often generated by Macros (such as the TOC Macro).

Specified by:

onId in interface Listener

Overrides:

onId in class AbstractChainingListener

Parameters:

name - the location name.

onImage

public void onImage(ResourceReference reference,
                    boolean isFreeStandingURI,
                    Map<String,String> parameters)

An image.

Specified by:

onImage in interface ImageListener

Overrides:

onImage in class AbstractChainingListener

Parameters:

reference - the image reference

isFreeStandingURI - if true then the image is defined directly as a URI in the text

parameters - a generic list of parameters. Example: style="background-color: blue"

Since:

2.5RC1

onNewLine

public void onNewLine()

Description copied from interface: Listener

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).

Specified by:

onNewLine in interface Listener

Overrides:

onNewLine in class AbstractChainingListener

onSpace

public void onSpace()

Description copied from interface: Listener

A space.

Specified by:

onSpace in interface Listener

Overrides:

onSpace in class AbstractChainingListener

onSpecialSymbol

public void onSpecialSymbol(char symbol)

Description copied from interface: Listener

A special symbol ("*", "<", ">", "=", quote, etc). Any non alpha numeric character is a special symbol.

Specified by:

onSpecialSymbol in interface Listener

Overrides:

onSpecialSymbol in class AbstractChainingListener

Parameters:

symbol - the symbol encountered

onVerbatim

public void onVerbatim(String protectedString,
                       boolean isInline,
                       Map<String,String> parameters)

Description copied from interface: Listener

A portion of text.

Specified by:

onVerbatim in interface Listener

Overrides:

onVerbatim in class AbstractChainingListener

Parameters:

protectedString - the string to protected from rendering

isInline - 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"

onWord

public void onWord(String word)

Description copied from interface: Listener

A word. Note that sentences ar broken into different events: word events, special symbols events, space events, etc. This allows fine-grained actions for listeners.

Specified by:

onWord in interface Listener

Overrides:

onWord in class AbstractChainingListener

Parameters:

word - the word encountered

onMacro

public void onMacro(String id,
                    Map<String,String> parameters,
                    String content,
                    boolean isInline)

Description copied from interface: Listener

A Macro.

Specified by:

onMacro in interface Listener

Overrides:

onMacro in class AbstractChainingListener

Parameters:

id - the macro id (eg "toc" for the TOC macro)

parameters - the macro parameters

content - the macro content

isInline - if true the macro is located in a inline content (like paragraph, etc.)