org.xwiki.rendering.internal.renderer.plain
Class PlainTextChainingRenderer

java.lang.Object
  org.xwiki.rendering.listener.chaining.AbstractChainingListener
      org.xwiki.rendering.renderer.AbstractChainingPrintRenderer
          org.xwiki.rendering.internal.renderer.plain.PlainTextChainingRenderer

All Implemented Interfaces:

ChainingListener, ImageListener, LinkListener, Listener, PrintRenderer, Renderer

public class PlainTextChainingRenderer
extends AbstractChainingPrintRenderer

Print only plain text information. For example it remove anything which need a specific syntax a simple plain text editor can't support like the style, link, image, etc. This renderer is mainly used to generate a simple as possible label like in a TOC.

Since:

1.9M1

Version:

$Id$

Field Summary

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

EMPTY_PARAMETERS

Constructor Summary

PlainTextChainingRenderer(LinkLabelGenerator linkLabelGenerator, ListenerChain listenerChain)

PlainTextChainingRenderer(ListenerChain listenerChain)
The plain text renderer supports when no link label generator is set.

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	beginList(ListType listType, Map<String,String> parameters) Start of a list.
void	beginListItem() Start of a list item.
void	beginParagraph(Map<String,String> parameters) Start of a paragraph.
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.
void	endLink(ResourceReference reference, boolean isFreeStandingURI, Map<String,String> parameters) End of a link.
protected EmptyBlockChainingListener	getEmptyBlockState()
void	onEmptyLines(int count) Represents an empty line between 2 standalone Blocks.
void	onHorizontalLine(Map<String,String> parameters) Represents an horizontal line.
void	onImage(ResourceReference reference, boolean isFreeStandingURI, Map<String,String> parameters) An image.
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	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.

Methods inherited from class org.xwiki.rendering.renderer.AbstractChainingPrintRenderer

getMainPrinter, getPrinter, popPrinter, pushPrinter, setPrinter

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

beginDocument, beginFormat, beginGroup, beginLink, beginMacroMarker, beginMetaData, beginQuotation, beginSection, endDefinitionDescription, endDefinitionList, endDefinitionTerm, endDocument, endFormat, endGroup, endHeader, endList, endListItem, endMacroMarker, endMetaData, endParagraph, endQuotation, endQuotationLine, endSection, endTable, endTableCell, endTableHeadCell, endTableRow, getListenerChain, onId, onMacro, onRawText, 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.Listener

beginDocument, beginFormat, beginGroup, beginMacroMarker, beginMetaData, beginQuotation, beginSection, endDefinitionDescription, endDefinitionList, endDefinitionTerm, endDocument, endFormat, endGroup, endHeader, endList, endListItem, endMacroMarker, endMetaData, endParagraph, endQuotation, endQuotationLine, endSection, endTable, endTableCell, endTableHeadCell, endTableRow, onId, onMacro, onRawText

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

beginLink

Constructor Detail

PlainTextChainingRenderer

public PlainTextChainingRenderer(ListenerChain listenerChain)

The plain text renderer supports when no link label generator is set.

PlainTextChainingRenderer

public PlainTextChainingRenderer(LinkLabelGenerator linkLabelGenerator,
                                 ListenerChain listenerChain)

Method Detail

getEmptyBlockState

protected EmptyBlockChainingListener getEmptyBlockState()

beginParagraph

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

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"

See Also:

AbstractChainingListener.beginParagraph(java.util.Map)

onNewLine

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

Specified by:

onNewLine in interface Listener

Overrides:

onNewLine in class AbstractChainingListener

See Also:

AbstractChainingListener.onNewLine()

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"

See Also:

AbstractChainingListener.endLink( org.xwiki.rendering.listener.reference.ResourceReference , boolean, java.util.Map)

beginHeader

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

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:

AbstractChainingListener.beginHeader(org.xwiki.rendering.listener.HeaderLevel, String, java.util.Map)

onWord

public void onWord(String word)

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

See Also:

AbstractChainingListener.onWord(java.lang.String)

beginList

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

Description copied from class: AbstractChainingListener

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:

Listener.beginList(ListType, Map)

beginListItem

public void beginListItem()

Start of a list item.

Specified by:

beginListItem in interface Listener

Overrides:

beginListItem in class AbstractChainingListener

See Also:

AbstractChainingListener.beginListItem()

onSpace

public void onSpace()

A space.

Specified by:

onSpace in interface Listener

Overrides:

onSpace in class AbstractChainingListener

See Also:

AbstractChainingListener.onSpace()

onSpecialSymbol

public void onSpecialSymbol(char symbol)

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

See Also:

AbstractChainingListener.onSpecialSymbol(char)

onHorizontalLine

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

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"

See Also:

AbstractChainingListener.onHorizontalLine(java.util.Map)

onEmptyLines

public void onEmptyLines(int count)

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

See Also:

AbstractChainingListener.onEmptyLines(int)

onVerbatim

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

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"

See Also:

AbstractChainingListener.onVerbatim(String, boolean, Map)

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

See Also:

Listener.beginDefinitionList(java.util.Map)

beginDefinitionTerm

public void beginDefinitionTerm()

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

See Also:

AbstractChainingListener.beginDefinitionTerm()

beginDefinitionDescription

public void beginDefinitionDescription()

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

See Also:

AbstractChainingListener.beginDefinitionDescription()

beginQuotationLine

public void beginQuotationLine()

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

See Also:

AbstractChainingListener.beginQuotationLine()

beginTable

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

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.

See Also:

AbstractChainingListener.beginTable(java.util.Map)

beginTableCell

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

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.

See Also:

AbstractChainingListener.beginTableCell(java.util.Map)

beginTableHeadCell

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

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.

See Also:

AbstractChainingListener.beginTableHeadCell(java.util.Map)

beginTableRow

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

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.

See Also:

AbstractChainingListener.beginTableRow(java.util.Map)

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

See Also:

AbstractChainingListener.onImage( org.xwiki.rendering.listener.reference.ResourceReference , boolean, java.util.Map)