org.xwiki.rendering.wikimodel.impl
Class WikiScannerContext

java.lang.Object
  org.xwiki.rendering.wikimodel.impl.WikiScannerContext

All Implemented Interfaces:

IWikiScannerContext, IWemConstants

Direct Known Subclasses:

ConfluenceWikiScannerContext

public class WikiScannerContext
extends Object
implements IWikiScannerContext

Since:

4.0M1

Version:

$Id: 6383d107a2d74a5775371272b9b696e0cf75b7ee $

Field Summary

protected IWemListener	fListener
protected SectionBuilder<WikiParameters>	fSectionBuilder
protected Stack<IWikiScannerContext>	fStack

Fields inherited from interface org.xwiki.rendering.wikimodel.IWemConstants

BIG, CITE, CODE, DEL, EM, INS, MONO, REF, SMALL, STRIKE, STRONG, SUB, SUP, TT

Constructor Summary

WikiScannerContext(IWemListener listener)

Method Summary

void	beginDocument()
void	beginDocument(WikiParameters params)
void	beginFormat(WikiParameters params)
void	beginFormat(WikiStyle wikiStyle)
void	beginHeader(int level)
void	beginHeader(int level, WikiParameters params)
void	beginInfo(String type, WikiParameters params)
void	beginList()
void	beginList(WikiParameters params)
void	beginListItem(String item)
void	beginListItem(String item, WikiParameters params)
void	beginParagraph()
void	beginParagraph(WikiParameters params)
void	beginPropertyBlock(String property, boolean doc)
void	beginPropertyInline(String str)
void	beginQuot()
void	beginQuot(WikiParameters params)
void	beginQuotLine(int depth)
void	beginTable()
void	beginTable(WikiParameters params)
void	beginTableCell(boolean headCell)
void	beginTableCell(boolean headCell, WikiParameters params)
void	beginTableRow(boolean headCell) Starts a new table row and adds the first cell to the table.
void	beginTableRow(boolean head, WikiParameters rowParams, WikiParameters cellParams) Starts a new table row and adds the first cell to the table.
void	beginTableRow(WikiParameters rowParams) Starts a new table row (but doesn't add a cell).
boolean	canApplyDefintionSplitter()
boolean	checkFormatStyle(WikiStyle style)
void	closeBlock()
void	endDocument()
void	endFormat(WikiParameters params)
void	endFormat(WikiStyle wikiStyle)
void	endHeader()
void	endInfo()
void	endList()
void	endListItem()
void	endParagraph()
void	endPropertyBlock()
void	endPropertyInline()
void	endQuot()
void	endQuotLine()
void	endTable()
void	endTableCell()
void	endTableExplicit()
void	endTableRow()
IWikiScannerContext	getContext()
IWemListener	getfListener()
InlineState	getInlineState()
int	getTableCellCounter()
int	getTableRowCounter()
boolean	isInDefinitionList()
boolean	isInDefinitionTerm()
boolean	isInHeader()
boolean	isInInlineProperty()
boolean	isInList()
boolean	isInTable()
boolean	isInTableCell()
boolean	isInTableRow()
protected InternalWikiScannerContext	newInternalContext()
void	onDefinitionListItemSplit()
void	onEmptyLines(int count)
void	onEscape(String str)
void	onExtensionBlock(String extensionName, WikiParameters params)
void	onExtensionInline(String extensionName, WikiParameters params)
void	onFormat(WikiParameters params)
void	onFormat(WikiStyle wikiStyle)
void	onFormat(WikiStyle wikiStyle, boolean forceClose)
void	onHorizontalLine()
void	onHorizontalLine(WikiParameters params)
void	onImage(String ref)
void	onImage(WikiReference ref)
void	onLineBreak()
void	onMacro(String name, WikiParameters params, String content)
void	onMacro(String macroName, WikiParameters params, String content, boolean inline)
void	onMacroBlock(String macroName, WikiParameters params, String content)
void	onMacroInline(String macroName, WikiParameters params, String content)
void	onNewLine()
void	onQuotLine(int depth)
void	onReference(String ref)
void	onReference(WikiReference ref)
void	onSpace(String str)
void	onSpecialSymbol(String str)
void	onTableCaption(String str)
void	onTableCell(boolean headCell)
void	onTableCell(boolean head, WikiParameters cellParams)
void	onTableRow(WikiParameters params) Explicitly starts a new table row.
void	onVerbatim(String str, boolean inline)
void	onVerbatim(String str, boolean inline, WikiParameters params)
void	onVerbatim(String str, WikiParameters params)
void	onWord(String str)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fListener

protected final IWemListener fListener

fSectionBuilder

protected SectionBuilder<WikiParameters> fSectionBuilder

fStack

protected final Stack<IWikiScannerContext> fStack

Constructor Detail

WikiScannerContext

public WikiScannerContext(IWemListener listener)

Method Detail

getfListener

public IWemListener getfListener()

beginDocument

public void beginDocument()

Specified by:

beginDocument in interface IWikiScannerContext

beginDocument

public void beginDocument(WikiParameters params)

Specified by:

beginDocument in interface IWikiScannerContext

beginFormat

public void beginFormat(WikiParameters params)

Specified by:

beginFormat in interface IWikiScannerContext

beginFormat

public void beginFormat(WikiStyle wikiStyle)

Specified by:

beginFormat in interface IWikiScannerContext

beginHeader

public void beginHeader(int level)

Specified by:

beginHeader in interface IWikiScannerContext

beginHeader

public void beginHeader(int level,
                        WikiParameters params)

Specified by:

beginHeader in interface IWikiScannerContext

beginInfo

public void beginInfo(String type,
                      WikiParameters params)

Specified by:

beginInfo in interface IWikiScannerContext

beginList

public void beginList()

Specified by:

beginList in interface IWikiScannerContext

beginList

public void beginList(WikiParameters params)

Specified by:

beginList in interface IWikiScannerContext

beginListItem

public void beginListItem(String item)

Specified by:

beginListItem in interface IWikiScannerContext

beginListItem

public void beginListItem(String item,
                          WikiParameters params)

Specified by:

beginListItem in interface IWikiScannerContext

beginParagraph

public void beginParagraph()

Specified by:

beginParagraph in interface IWikiScannerContext

beginParagraph

public void beginParagraph(WikiParameters params)

Specified by:

beginParagraph in interface IWikiScannerContext

beginPropertyBlock

public void beginPropertyBlock(String property,
                               boolean doc)

Specified by:

beginPropertyBlock in interface IWikiScannerContext

beginPropertyInline

public void beginPropertyInline(String str)

Specified by:

beginPropertyInline in interface IWikiScannerContext

beginQuot

public void beginQuot()

Specified by:

beginQuot in interface IWikiScannerContext

beginQuot

public void beginQuot(WikiParameters params)

Specified by:

beginQuot in interface IWikiScannerContext

beginQuotLine

public void beginQuotLine(int depth)

Specified by:

beginQuotLine in interface IWikiScannerContext

beginTable

public void beginTable()

Specified by:

beginTable in interface IWikiScannerContext

beginTable

public void beginTable(WikiParameters params)

Specified by:

beginTable in interface IWikiScannerContext

beginTableCell

public void beginTableCell(boolean headCell)

Specified by:

beginTableCell in interface IWikiScannerContext

beginTableCell

public void beginTableCell(boolean headCell,
                           WikiParameters params)

Specified by:

beginTableCell in interface IWikiScannerContext

beginTableRow

public void beginTableRow(boolean headCell)

Description copied from interface: IWikiScannerContext

Starts a new table row and adds the first cell to the table.

Specified by:

beginTableRow in interface IWikiScannerContext

Parameters:

headCell - if this parameter is true then this method starts the header cell at the beginning of the line

beginTableRow

public void beginTableRow(boolean head,
                          WikiParameters rowParams,
                          WikiParameters cellParams)

Description copied from interface: IWikiScannerContext

Starts a new table row and adds the first cell to the table.

Specified by:

beginTableRow in interface IWikiScannerContext

Parameters:

head - if this parameter is true then this method starts the header cell at the beginning of the line

rowParams - parameters of the row

cellParams - parameters of the first row cell

beginTableRow

public void beginTableRow(WikiParameters rowParams)

Description copied from interface: IWikiScannerContext

Starts a new table row (but doesn't add a cell).

Specified by:

beginTableRow in interface IWikiScannerContext

canApplyDefintionSplitter

public boolean canApplyDefintionSplitter()

Specified by:

canApplyDefintionSplitter in interface IWikiScannerContext

checkFormatStyle

public boolean checkFormatStyle(WikiStyle style)

Specified by:

checkFormatStyle in interface IWikiScannerContext

closeBlock

public void closeBlock()

Specified by:

closeBlock in interface IWikiScannerContext

endDocument

public void endDocument()

Specified by:

endDocument in interface IWikiScannerContext

endFormat

public void endFormat(WikiParameters params)

Specified by:

endFormat in interface IWikiScannerContext

endFormat

public void endFormat(WikiStyle wikiStyle)

Specified by:

endFormat in interface IWikiScannerContext

endHeader

public void endHeader()

Specified by:

endHeader in interface IWikiScannerContext

endInfo

public void endInfo()

Specified by:

endInfo in interface IWikiScannerContext

endList

public void endList()

Specified by:

endList in interface IWikiScannerContext

endListItem

public void endListItem()

Specified by:

endListItem in interface IWikiScannerContext

endParagraph

public void endParagraph()

Specified by:

endParagraph in interface IWikiScannerContext

endPropertyBlock

public void endPropertyBlock()

Specified by:

endPropertyBlock in interface IWikiScannerContext

endPropertyInline

public void endPropertyInline()

Specified by:

endPropertyInline in interface IWikiScannerContext

endQuot

public void endQuot()

Specified by:

endQuot in interface IWikiScannerContext

endQuotLine

public void endQuotLine()

Specified by:

endQuotLine in interface IWikiScannerContext

endTable

public void endTable()

Specified by:

endTable in interface IWikiScannerContext

endTableCell

public void endTableCell()

Specified by:

endTableCell in interface IWikiScannerContext

endTableExplicit

public void endTableExplicit()

Specified by:

endTableExplicit in interface IWikiScannerContext

endTableRow

public void endTableRow()

Specified by:

endTableRow in interface IWikiScannerContext

getContext

public IWikiScannerContext getContext()

getInlineState

public InlineState getInlineState()

Specified by:

getInlineState in interface IWikiScannerContext

getTableCellCounter

public int getTableCellCounter()

Specified by:

getTableCellCounter in interface IWikiScannerContext

getTableRowCounter

public int getTableRowCounter()

Specified by:

getTableRowCounter in interface IWikiScannerContext

isInDefinitionList

public boolean isInDefinitionList()

Specified by:

isInDefinitionList in interface IWikiScannerContext

isInDefinitionTerm

public boolean isInDefinitionTerm()

Specified by:

isInDefinitionTerm in interface IWikiScannerContext

isInHeader

public boolean isInHeader()

Specified by:

isInHeader in interface IWikiScannerContext

isInInlineProperty

public boolean isInInlineProperty()

Specified by:

isInInlineProperty in interface IWikiScannerContext

isInList

public boolean isInList()

Specified by:

isInList in interface IWikiScannerContext

isInTable

public boolean isInTable()

Specified by:

isInTable in interface IWikiScannerContext

isInTableCell

public boolean isInTableCell()

Specified by:

isInTableCell in interface IWikiScannerContext

isInTableRow

public boolean isInTableRow()

Specified by:

isInTableRow in interface IWikiScannerContext

newInternalContext

protected InternalWikiScannerContext newInternalContext()

Returns:

onDefinitionListItemSplit

public void onDefinitionListItemSplit()

Specified by:

onDefinitionListItemSplit in interface IWikiScannerContext

onEmptyLines

public void onEmptyLines(int count)

Specified by:

onEmptyLines in interface IWikiScannerContext

onEscape

public void onEscape(String str)

Specified by:

onEscape in interface IWikiScannerContext

onExtensionBlock

public void onExtensionBlock(String extensionName,
                             WikiParameters params)

Specified by:

onExtensionBlock in interface IWikiScannerContext

onExtensionInline

public void onExtensionInline(String extensionName,
                              WikiParameters params)

Specified by:

onExtensionInline in interface IWikiScannerContext

onFormat

public void onFormat(WikiParameters params)

Specified by:

onFormat in interface IWikiScannerContext

onFormat

public void onFormat(WikiStyle wikiStyle)

Specified by:

onFormat in interface IWikiScannerContext

onFormat

public void onFormat(WikiStyle wikiStyle,
                     boolean forceClose)

Specified by:

onFormat in interface IWikiScannerContext

See Also:

onFormat(org.xwiki.rendering.wikimodel.WikiStyle, boolean)

onHorizontalLine

public void onHorizontalLine()

Specified by:

onHorizontalLine in interface IWikiScannerContext

onHorizontalLine

public void onHorizontalLine(WikiParameters params)

Specified by:

onHorizontalLine in interface IWikiScannerContext

onImage

public void onImage(String ref)

Specified by:

onImage in interface IWikiScannerContext

onImage

public void onImage(WikiReference ref)

Specified by:

onImage in interface IWikiScannerContext

onLineBreak

public void onLineBreak()

Specified by:

onLineBreak in interface IWikiScannerContext

onMacro

public void onMacro(String name,
                    WikiParameters params,
                    String content)

Specified by:

onMacro in interface IWikiScannerContext

onMacro

public void onMacro(String macroName,
                    WikiParameters params,
                    String content,
                    boolean inline)

Specified by:

onMacro in interface IWikiScannerContext

onMacroBlock

public void onMacroBlock(String macroName,
                         WikiParameters params,
                         String content)

Specified by:

onMacroBlock in interface IWikiScannerContext

onMacroInline

public void onMacroInline(String macroName,
                          WikiParameters params,
                          String content)

Specified by:

onMacroInline in interface IWikiScannerContext

onNewLine

public void onNewLine()

Specified by:

onNewLine in interface IWikiScannerContext

onQuotLine

public void onQuotLine(int depth)

Specified by:

onQuotLine in interface IWikiScannerContext

onReference

public void onReference(String ref)

Specified by:

onReference in interface IWikiScannerContext

onReference

public void onReference(WikiReference ref)

Specified by:

onReference in interface IWikiScannerContext

onSpace

public void onSpace(String str)

Specified by:

onSpace in interface IWikiScannerContext

onSpecialSymbol

public void onSpecialSymbol(String str)

Specified by:

onSpecialSymbol in interface IWikiScannerContext

onTableCaption

public void onTableCaption(String str)

Specified by:

onTableCaption in interface IWikiScannerContext

onTableCell

public void onTableCell(boolean headCell)

Specified by:

onTableCell in interface IWikiScannerContext

onTableCell

public void onTableCell(boolean head,
                        WikiParameters cellParams)

Specified by:

onTableCell in interface IWikiScannerContext

onTableRow

public void onTableRow(WikiParameters params)

Description copied from interface: IWikiScannerContext

Explicitly starts a new table row. This method should not create a new cell at the beginning of the line. To automatically create the first row cell the methods IWikiScannerContext.beginTableCell(boolean) or IWikiScannerContext.beginTableRow(boolean, WikiParameters, WikiParameters) should be used.

Specified by:

onTableRow in interface IWikiScannerContext

See Also:

onTableRow(org.xwiki.rendering.wikimodel.WikiParameters)

onVerbatim

public void onVerbatim(String str,
                       boolean inline)

Specified by:

onVerbatim in interface IWikiScannerContext

See Also:

onVerbatim(java.lang.String, boolean)

onVerbatim

public void onVerbatim(String str,
                       boolean inline,
                       WikiParameters params)

Specified by:

onVerbatim in interface IWikiScannerContext

onVerbatim

public void onVerbatim(String str,
                       WikiParameters params)

Specified by:

onVerbatim in interface IWikiScannerContext

onWord

public void onWord(String str)

Specified by:

onWord in interface IWikiScannerContext