IWikiScannerContext (XWiki Rendering - WikiModel 7.4-rc-1 API)

All Superinterfaces:

IWemConstants

All Known Implementing Classes:

ConfluenceInternalWikiScannerContext, ConfluenceWikiScannerContext, InternalWikiScannerContext, WikiScannerContext
```
public interface IWikiScannerContext
extends IWemConstants
```
Since:

4.0M1

Version:

$Id: b634b5abfd98098249626f87f4a42dadc208ff30 $

Property Summary

Properties
Type Property and Description

boolean isInInline

Properties
Type	Property and Description
`boolean`	`isInInline`

Field Summary
- Fields inherited from interface org.xwiki.rendering.wikimodel.IWemConstants
  BIG, CITE, CODE, DEL, EM, INS, MONO, REF, SMALL, STRIKE, STRONG, SUB, SUP, TT

Method Summary

Methods
Modifier and Type	Method and Description
`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()`
`InlineState`	`getInlineState()`
`int`	`getTableCellCounter()`
`int`	`getTableRowCounter()`
`boolean`	`isInDefinitionList()`
`boolean`	`isInDefinitionTerm()`
`boolean`	`isInHeader()`
`boolean`	`isInInlineProperty()`
`boolean`	`isInList()`
`boolean`	`isInTable()`
`boolean`	`isInTableCell()`
`boolean`	`isInTableRow()`
`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)`

Property Detail
- isInInline

Method Detail

beginDocument
```
void beginDocument()
```

beginDocument

void beginDocument(WikiParameters params)

beginHeader
```
void beginHeader(int level)
```

beginHeader

void beginHeader(int level,
               WikiParameters params)

beginInfo

void beginInfo(String type,
             WikiParameters params)

beginList
```
void beginList()
```

beginList
```
void beginList(WikiParameters params)
```

beginListItem
```
void beginListItem(String item)
```

beginListItem

void beginListItem(String item,
                 WikiParameters params)

beginParagraph
```
void beginParagraph()
```

beginParagraph

void beginParagraph(WikiParameters params)

beginPropertyBlock

void beginPropertyBlock(String property,
                      boolean doc)

beginPropertyInline
```
void beginPropertyInline(String str)
```

beginQuot
```
void beginQuot()
```

beginQuot
```
void beginQuot(WikiParameters params)
```

beginQuotLine
```
void beginQuotLine(int depth)
```

beginTable
```
void beginTable()
```

beginTable

void beginTable(WikiParameters params)

beginTableCell
```
void beginTableCell(boolean headCell)
```

beginTableCell

void beginTableCell(boolean headCell,
                  WikiParameters params)

beginTableRow
```
void beginTableRow(boolean headCell)
```
Starts a new table row and adds the first cell to the table.

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

beginTableRow
```
void beginTableRow(boolean head,
                 WikiParameters rowParams,
                 WikiParameters cellParams)
```
Starts a new table row and adds the first cell to the table.

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
```
void beginTableRow(WikiParameters rowParams)
```
Starts a new table row (but doesn't add a cell).

canApplyDefintionSplitter
```
boolean canApplyDefintionSplitter()
```

checkFormatStyle

boolean checkFormatStyle(WikiStyle style)

closeBlock
```
void closeBlock()
```

endDocument
```
void endDocument()
```

endHeader
```
void endHeader()
```

endInfo
```
void endInfo()
```

endList
```
void endList()
```

endListItem
```
void endListItem()
```

endParagraph
```
void endParagraph()
```

endPropertyBlock
```
void endPropertyBlock()
```

endPropertyInline
```
void endPropertyInline()
```

endQuot
```
void endQuot()
```

endQuotLine
```
void endQuotLine()
```

endTable
```
void endTable()
```

endTableCell
```
void endTableCell()
```

endTableExplicit
```
void endTableExplicit()
```

endTableRow
```
void endTableRow()
```

getInlineState
```
InlineState getInlineState()
```

getTableCellCounter
```
int getTableCellCounter()
```

getTableRowCounter
```
int getTableRowCounter()
```

isInDefinitionList
```
boolean isInDefinitionList()
```

isInDefinitionTerm
```
boolean isInDefinitionTerm()
```

isInHeader
```
boolean isInHeader()
```

isInInlineProperty
```
boolean isInInlineProperty()
```

isInList
```
boolean isInList()
```

isInTable
```
boolean isInTable()
```

isInTableCell
```
boolean isInTableCell()
```

isInTableRow
```
boolean isInTableRow()
```

onDefinitionListItemSplit
```
void onDefinitionListItemSplit()
```

onEmptyLines
```
void onEmptyLines(int count)
```

onEscape
```
void onEscape(String str)
```

onExtensionBlock

void onExtensionBlock(String extensionName,
                    WikiParameters params)

onExtensionInline

void onExtensionInline(String extensionName,
                     WikiParameters params)

onFormat
```
void onFormat(WikiParameters params)
```

onFormat
```
void onFormat(WikiStyle wikiStyle)
```

beginFormat

void beginFormat(WikiParameters params)

beginFormat
```
void beginFormat(WikiStyle wikiStyle)
```

endFormat
```
void endFormat(WikiParameters params)
```

endFormat
```
void endFormat(WikiStyle wikiStyle)
```

onFormat
```
void onFormat(WikiStyle wikiStyle,
            boolean forceClose)
```
See Also:
WikiScannerContext.onFormat(org.xwiki.rendering.wikimodel.WikiStyle, boolean)

onHorizontalLine
```
void onHorizontalLine()
```

onHorizontalLine

void onHorizontalLine(WikiParameters params)

onImage
```
void onImage(String ref)
```

onImage
```
void onImage(WikiReference ref)
```

onLineBreak
```
void onLineBreak()
```

onMacro

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

onMacro

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

onMacroBlock

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

onMacroInline

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

onNewLine
```
void onNewLine()
```

onQuotLine
```
void onQuotLine(int depth)
```

onReference
```
void onReference(String ref)
```

onReference
```
void onReference(WikiReference ref)
```

onSpace
```
void onSpace(String str)
```

onSpecialSymbol
```
void onSpecialSymbol(String str)
```

onTableCaption
```
void onTableCaption(String str)
```

onTableCell
```
void onTableCell(boolean headCell)
```

onTableCell

void onTableCell(boolean head,
               WikiParameters cellParams)

onTableRow
```
void onTableRow(WikiParameters params)
```
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 beginTableCell(boolean) or beginTableRow(boolean, WikiParameters, WikiParameters) should be used.

onVerbatim

void onVerbatim(String str,
              WikiParameters params)

onVerbatim
```
void onVerbatim(String str,
              boolean inline)
```
See Also:
WikiScannerContext.onVerbatim(java.lang.String, boolean)

onVerbatim

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

onWord
```
void onWord(String str)
```

Interface IWikiScannerContext

Property Summary

Field Summary

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

Method Summary

Property Detail

isInInline

Method Detail

beginDocument

beginDocument

beginHeader

beginHeader

beginInfo

beginList

beginList

beginListItem

beginListItem

beginParagraph

beginParagraph

beginPropertyBlock

beginPropertyInline

beginQuot

beginQuot

beginQuotLine

beginTable

beginTable

beginTableCell

beginTableCell

beginTableRow

beginTableRow

beginTableRow

canApplyDefintionSplitter

checkFormatStyle

closeBlock

endDocument

endHeader

endInfo

endList

endListItem

endParagraph

endPropertyBlock

endPropertyInline

endQuot

endQuotLine

endTable

endTableCell

endTableExplicit

endTableRow

getInlineState

getTableCellCounter

getTableRowCounter

isInDefinitionList

isInDefinitionTerm

isInHeader

isInInlineProperty

isInList

isInTable

isInTableCell

isInTableRow

onDefinitionListItemSplit

onEmptyLines

onEscape

onExtensionBlock

onExtensionInline

onFormat

onFormat

beginFormat

beginFormat

endFormat

endFormat

onFormat

onHorizontalLine

onHorizontalLine

onImage

onImage

onLineBreak

onMacro

onMacro

onMacroBlock

onMacroInline