Class InternalWikiScannerContext
- java.lang.Object
-
- org.xwiki.rendering.wikimodel.impl.InternalWikiScannerContext
-
- All Implemented Interfaces:
IWikiScannerContext,IWemConstants
public class InternalWikiScannerContext extends Object implements IWikiScannerContext
- Since:
- 4.0M1
- Version:
- $Id: 021cf3d0188600f7456fdbc0e2f565355ae4c6de $
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static interfaceInternalWikiScannerContext.IBlockTypes
-
Field Summary
-
Constructor Summary
Constructors Constructor Description InternalWikiScannerContext(SectionBuilder<WikiParameters> sectionBuilder, IWemListener listener)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidbeginDocument()voidbeginDocument(WikiParameters params)voidbeginFigure(WikiParameters params)Starts a new figure.voidbeginFigureCaption(WikiParameters params)Starts a figure caption.voidbeginFormat(WikiParameters params)voidbeginFormat(WikiStyle wikiStyle)voidbeginHeader(int level)voidbeginHeader(int level, WikiParameters params)voidbeginInfo(String type, WikiParameters params)voidbeginList()voidbeginList(WikiParameters params)voidbeginListItem(String item)voidbeginListItem(String item, WikiParameters listParams)voidbeginListItem(String item, WikiParameters listParams, WikiParameters itemParams)voidbeginParagraph()voidbeginParagraph(WikiParameters params)voidbeginPropertyBlock(String property, boolean doc)voidbeginPropertyInline(String str)voidbeginQuot()voidbeginQuot(WikiParameters params)voidbeginQuotLine(int depth)protected voidbeginStyleContainer()voidbeginTable()voidbeginTable(WikiParameters params)voidbeginTableCell(boolean headCell)voidbeginTableCell(boolean headCell, WikiParameters params)voidbeginTableRow(boolean headCell)Starts a new table row and adds the first cell to the table.voidbeginTableRow(boolean head, WikiParameters rowParams, WikiParameters cellParams)Starts a new table row and adds the first cell to the table.voidbeginTableRow(WikiParameters rowParams)Starts a new table row (but doesn't add a cell).booleancanApplyDefintionSplitter()booleancheckFormatStyle(WikiStyle style)protected voidcheckStyleOpened()voidcloseBlock()voidcloseFormat()voidendDocument()voidendFigure()Ends a figure.voidendFigureCaption()Ends a figure caption.voidendFormat(WikiParameters params)voidendFormat(WikiStyle wikiStyle)voidendHeader()voidendInfo()voidendList()voidendListItem()voidendParagraph()voidendPropertyBlock()voidendPropertyInline()voidendQuot()voidendQuotLine()protected voidendStyleContainer()voidendTable()voidendTableCell()voidendTableExplicit()voidendTableRow()InlineStategetInlineState()intgetTableCellCounter()Returns the tableCellCounter.intgetTableRowCounter()Returns the tableRowCounter.booleanisInDefinitionList()Returns the inDefinitionList.booleanisInDefinitionTerm()booleanisInHeader()Returns the inHeader.booleanisInInlineProperty()booleanisInList()Returns the inList.booleanisInQuotation()booleanisInTable()booleanisInTableCell()booleanisInTableRow()voidonDefinitionListItemSplit()voidonEmptyLines(int count)voidonEscape(String str)voidonExtensionBlock(String extensionName, WikiParameters params)voidonExtensionInline(String extensionName, WikiParameters params)voidonFormat(WikiParameters params)voidonFormat(WikiStyle wikiStyle)voidonFormat(WikiStyle wikiStyle, boolean forceClose)voidonHorizontalLine()voidonHorizontalLine(WikiParameters params)voidonImage(String ref)voidonImage(WikiReference ref)voidonLineBreak()voidonMacro(String name, WikiParameters params, String content)Waiting for following events to know if the macro is inline or not.voidonMacro(String macroName, WikiParameters params, String content, boolean inline)voidonMacroBlock(String macroName, WikiParameters params, String content)voidonMacroInline(String macroName, WikiParameters params, String content)voidonNewLine()voidonQuotLine(int depth)voidonReference(String ref)voidonReference(WikiReference ref)voidonSpace(String str)voidonSpecialSymbol(String str)voidonTableCaption(String str)voidonTableCell(boolean headCell)voidonTableCell(boolean head, WikiParameters params)voidonTableRow(WikiParameters params)Explicitly starts a new table row.voidonVerbatim(String str, boolean inline)voidonVerbatim(String str, boolean inline, WikiParameters params)voidonVerbatim(String str, WikiParameters params)Waiting for following events to know if the verbatim is inline or not.voidonWord(String str)
-
-
-
Field Detail
-
fBlockType
protected int fBlockType
-
fFormat
protected WikiFormat fFormat
-
fHeaderLevel
protected int fHeaderLevel
-
fInfoParams
protected WikiParameters fInfoParams
-
fInfoType
protected String fInfoType
-
fInlineProperty
protected String fInlineProperty
-
fInlineState
protected InlineState fInlineState
-
fListBuilder
protected ListBuilder fListBuilder
-
fListener
protected final IWemListener fListener
-
fListParams
protected WikiParameters fListParams
-
fListItem
protected WikiParameters fListItem
-
fMacroContent
protected String fMacroContent
-
fMacroName
protected String fMacroName
-
fMacroParameters
protected WikiParameters fMacroParameters
-
fNewFormat
protected WikiFormat fNewFormat
-
fParagraphParams
protected WikiParameters fParagraphParams
-
fQuotBuilder
protected ListBuilder fQuotBuilder
-
fQuoteDepth
protected int fQuoteDepth
-
fQuotParams
protected WikiParameters fQuotParams
-
fSectionBuilder
protected SectionBuilder<WikiParameters> fSectionBuilder
-
fTableCellCounter
protected int fTableCellCounter
-
fTableCellParams
protected WikiParameters fTableCellParams
-
fTableHead
protected boolean fTableHead
-
fTableParams
protected WikiParameters fTableParams
-
fTableRowCounter
protected int fTableRowCounter
-
fTableRowParams
protected WikiParameters fTableRowParams
-
fVerbatimContent
protected String fVerbatimContent
-
fVerbatimParameters
protected WikiParameters fVerbatimParameters
-
fFigureCaptionParameters
protected WikiParameters fFigureCaptionParameters
-
-
Constructor Detail
-
InternalWikiScannerContext
public InternalWikiScannerContext(SectionBuilder<WikiParameters> sectionBuilder, IWemListener listener)
-
-
Method Detail
-
beginDocument
public void beginDocument()
- Specified by:
beginDocumentin interfaceIWikiScannerContext
-
beginDocument
public void beginDocument(WikiParameters params)
- Specified by:
beginDocumentin interfaceIWikiScannerContext
-
beginFormat
public void beginFormat(WikiParameters params)
- Specified by:
beginFormatin interfaceIWikiScannerContext
-
beginFormat
public void beginFormat(WikiStyle wikiStyle)
- Specified by:
beginFormatin interfaceIWikiScannerContext
-
beginHeader
public void beginHeader(int level)
- Specified by:
beginHeaderin interfaceIWikiScannerContext
-
beginHeader
public void beginHeader(int level, WikiParameters params)- Specified by:
beginHeaderin interfaceIWikiScannerContext
-
beginInfo
public void beginInfo(String type, WikiParameters params)
- Specified by:
beginInfoin interfaceIWikiScannerContext
-
beginFigure
public void beginFigure(WikiParameters params)
Description copied from interface:IWikiScannerContextStarts a new figure.- Specified by:
beginFigurein interfaceIWikiScannerContext- Parameters:
params- Parameters of the figure.
-
beginFigureCaption
public void beginFigureCaption(WikiParameters params)
Description copied from interface:IWikiScannerContextStarts a figure caption. This must only be used inside a figure.- Specified by:
beginFigureCaptionin interfaceIWikiScannerContext- Parameters:
params- The parameters of the caption.
-
beginList
public void beginList()
- Specified by:
beginListin interfaceIWikiScannerContext
-
beginList
public void beginList(WikiParameters params)
- Specified by:
beginListin interfaceIWikiScannerContext
-
beginListItem
public void beginListItem(String item)
- Specified by:
beginListItemin interfaceIWikiScannerContext
-
beginListItem
public void beginListItem(String item, WikiParameters listParams)
- Specified by:
beginListItemin interfaceIWikiScannerContext
-
beginListItem
public void beginListItem(String item, WikiParameters listParams, WikiParameters itemParams)
- Specified by:
beginListItemin interfaceIWikiScannerContext
-
beginParagraph
public void beginParagraph()
- Specified by:
beginParagraphin interfaceIWikiScannerContext
-
beginParagraph
public void beginParagraph(WikiParameters params)
- Specified by:
beginParagraphin interfaceIWikiScannerContext
-
beginPropertyBlock
public void beginPropertyBlock(String property, boolean doc)
- Specified by:
beginPropertyBlockin interfaceIWikiScannerContext
-
beginPropertyInline
public void beginPropertyInline(String str)
- Specified by:
beginPropertyInlinein interfaceIWikiScannerContext
-
beginQuot
public void beginQuot()
- Specified by:
beginQuotin interfaceIWikiScannerContext
-
beginQuot
public void beginQuot(WikiParameters params)
- Specified by:
beginQuotin interfaceIWikiScannerContext
-
beginQuotLine
public void beginQuotLine(int depth)
- Specified by:
beginQuotLinein interfaceIWikiScannerContext- See Also:
IWikiScannerContext.beginQuotLine(int)
-
beginStyleContainer
protected void beginStyleContainer()
-
beginTable
public void beginTable()
- Specified by:
beginTablein interfaceIWikiScannerContext
-
beginTable
public void beginTable(WikiParameters params)
- Specified by:
beginTablein interfaceIWikiScannerContext
-
beginTableCell
public void beginTableCell(boolean headCell)
- Specified by:
beginTableCellin interfaceIWikiScannerContext
-
beginTableCell
public void beginTableCell(boolean headCell, WikiParameters params)- Specified by:
beginTableCellin interfaceIWikiScannerContext
-
beginTableRow
public void beginTableRow(boolean headCell)
Description copied from interface:IWikiScannerContextStarts a new table row and adds the first cell to the table.- Specified by:
beginTableRowin interfaceIWikiScannerContext- Parameters:
headCell- if this parameter istruethen 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:IWikiScannerContextStarts a new table row and adds the first cell to the table.- Specified by:
beginTableRowin interfaceIWikiScannerContext- Parameters:
head- if this parameter istruethen this method starts the header cell at the beginning of the linerowParams- parameters of the rowcellParams- parameters of the first row cell
-
beginTableRow
public void beginTableRow(WikiParameters rowParams)
Description copied from interface:IWikiScannerContextStarts a new table row (but doesn't add a cell).- Specified by:
beginTableRowin interfaceIWikiScannerContext
-
canApplyDefintionSplitter
public boolean canApplyDefintionSplitter()
- Specified by:
canApplyDefintionSplitterin interfaceIWikiScannerContext
-
checkFormatStyle
public boolean checkFormatStyle(WikiStyle style)
- Specified by:
checkFormatStylein interfaceIWikiScannerContext
-
checkStyleOpened
protected void checkStyleOpened()
-
closeBlock
public void closeBlock()
- Specified by:
closeBlockin interfaceIWikiScannerContext
-
closeFormat
public void closeFormat()
-
endDocument
public void endDocument()
- Specified by:
endDocumentin interfaceIWikiScannerContext
-
endFormat
public void endFormat(WikiParameters params)
- Specified by:
endFormatin interfaceIWikiScannerContext
-
endFormat
public void endFormat(WikiStyle wikiStyle)
- Specified by:
endFormatin interfaceIWikiScannerContext
-
endHeader
public void endHeader()
- Specified by:
endHeaderin interfaceIWikiScannerContext
-
endInfo
public void endInfo()
- Specified by:
endInfoin interfaceIWikiScannerContext
-
endList
public void endList()
- Specified by:
endListin interfaceIWikiScannerContext
-
endListItem
public void endListItem()
- Specified by:
endListItemin interfaceIWikiScannerContext
-
endParagraph
public void endParagraph()
- Specified by:
endParagraphin interfaceIWikiScannerContext
-
endPropertyBlock
public void endPropertyBlock()
- Specified by:
endPropertyBlockin interfaceIWikiScannerContext
-
endPropertyInline
public void endPropertyInline()
- Specified by:
endPropertyInlinein interfaceIWikiScannerContext
-
endQuot
public void endQuot()
- Specified by:
endQuotin interfaceIWikiScannerContext
-
endQuotLine
public void endQuotLine()
- Specified by:
endQuotLinein interfaceIWikiScannerContext
-
endStyleContainer
protected void endStyleContainer()
-
endTable
public void endTable()
- Specified by:
endTablein interfaceIWikiScannerContext
-
endTableCell
public void endTableCell()
- Specified by:
endTableCellin interfaceIWikiScannerContext
-
endTableExplicit
public void endTableExplicit()
- Specified by:
endTableExplicitin interfaceIWikiScannerContext
-
endTableRow
public void endTableRow()
- Specified by:
endTableRowin interfaceIWikiScannerContext
-
endFigure
public void endFigure()
Description copied from interface:IWikiScannerContextEnds a figure.- Specified by:
endFigurein interfaceIWikiScannerContext
-
endFigureCaption
public void endFigureCaption()
Description copied from interface:IWikiScannerContextEnds a figure caption.- Specified by:
endFigureCaptionin interfaceIWikiScannerContext
-
getInlineState
public InlineState getInlineState()
- Specified by:
getInlineStatein interfaceIWikiScannerContext
-
getTableCellCounter
public int getTableCellCounter()
Returns the tableCellCounter.- Specified by:
getTableCellCounterin interfaceIWikiScannerContext- Returns:
- the tableCellCounter.
-
getTableRowCounter
public int getTableRowCounter()
Returns the tableRowCounter.- Specified by:
getTableRowCounterin interfaceIWikiScannerContext- Returns:
- the tableRowCounter.
-
isInDefinitionList
public boolean isInDefinitionList()
Returns the inDefinitionList.- Specified by:
isInDefinitionListin interfaceIWikiScannerContext- Returns:
- the inDefinitionList.
-
isInDefinitionTerm
public boolean isInDefinitionTerm()
- Specified by:
isInDefinitionTermin interfaceIWikiScannerContext
-
isInHeader
public boolean isInHeader()
Returns the inHeader.- Specified by:
isInHeaderin interfaceIWikiScannerContext- Returns:
- the inHeader.
-
isInInlineProperty
public boolean isInInlineProperty()
- Specified by:
isInInlinePropertyin interfaceIWikiScannerContext
-
isInList
public boolean isInList()
Returns the inList.- Specified by:
isInListin interfaceIWikiScannerContext- Returns:
- the inList.
-
isInQuotation
public boolean isInQuotation()
-
isInTable
public boolean isInTable()
- Specified by:
isInTablein interfaceIWikiScannerContext
-
isInTableCell
public boolean isInTableCell()
- Specified by:
isInTableCellin interfaceIWikiScannerContext
-
isInTableRow
public boolean isInTableRow()
- Specified by:
isInTableRowin interfaceIWikiScannerContext
-
onDefinitionListItemSplit
public void onDefinitionListItemSplit()
- Specified by:
onDefinitionListItemSplitin interfaceIWikiScannerContext
-
onEmptyLines
public void onEmptyLines(int count)
- Specified by:
onEmptyLinesin interfaceIWikiScannerContext
-
onEscape
public void onEscape(String str)
- Specified by:
onEscapein interfaceIWikiScannerContext
-
onExtensionBlock
public void onExtensionBlock(String extensionName, WikiParameters params)
- Specified by:
onExtensionBlockin interfaceIWikiScannerContext
-
onExtensionInline
public void onExtensionInline(String extensionName, WikiParameters params)
- Specified by:
onExtensionInlinein interfaceIWikiScannerContext
-
onFormat
public void onFormat(WikiParameters params)
- Specified by:
onFormatin interfaceIWikiScannerContext
-
onFormat
public void onFormat(WikiStyle wikiStyle)
- Specified by:
onFormatin interfaceIWikiScannerContext
-
onFormat
public void onFormat(WikiStyle wikiStyle, boolean forceClose)
- Specified by:
onFormatin interfaceIWikiScannerContext- See Also:
WikiScannerContext.onFormat(org.xwiki.rendering.wikimodel.WikiStyle, boolean)
-
onHorizontalLine
public void onHorizontalLine()
- Specified by:
onHorizontalLinein interfaceIWikiScannerContext
-
onHorizontalLine
public void onHorizontalLine(WikiParameters params)
- Specified by:
onHorizontalLinein interfaceIWikiScannerContext
-
onImage
public void onImage(String ref)
- Specified by:
onImagein interfaceIWikiScannerContext
-
onImage
public void onImage(WikiReference ref)
- Specified by:
onImagein interfaceIWikiScannerContext
-
onLineBreak
public void onLineBreak()
- Specified by:
onLineBreakin interfaceIWikiScannerContext
-
onMacro
public void onMacro(String name, WikiParameters params, String content)
Waiting for following events to know if the macro is inline or not.- Specified by:
onMacroin interfaceIWikiScannerContext
-
onMacro
public void onMacro(String macroName, WikiParameters params, String content, boolean inline)
- Specified by:
onMacroin interfaceIWikiScannerContext
-
onMacroBlock
public void onMacroBlock(String macroName, WikiParameters params, String content)
- Specified by:
onMacroBlockin interfaceIWikiScannerContext
-
onMacroInline
public void onMacroInline(String macroName, WikiParameters params, String content)
- Specified by:
onMacroInlinein interfaceIWikiScannerContext
-
onNewLine
public void onNewLine()
- Specified by:
onNewLinein interfaceIWikiScannerContext
-
onQuotLine
public void onQuotLine(int depth)
- Specified by:
onQuotLinein interfaceIWikiScannerContext
-
onReference
public void onReference(String ref)
- Specified by:
onReferencein interfaceIWikiScannerContext
-
onReference
public void onReference(WikiReference ref)
- Specified by:
onReferencein interfaceIWikiScannerContext
-
onSpace
public void onSpace(String str)
- Specified by:
onSpacein interfaceIWikiScannerContext
-
onSpecialSymbol
public void onSpecialSymbol(String str)
- Specified by:
onSpecialSymbolin interfaceIWikiScannerContext
-
onTableCaption
public void onTableCaption(String str)
- Specified by:
onTableCaptionin interfaceIWikiScannerContext
-
onTableCell
public void onTableCell(boolean headCell)
- Specified by:
onTableCellin interfaceIWikiScannerContext
-
onTableCell
public void onTableCell(boolean head, WikiParameters params)- Specified by:
onTableCellin interfaceIWikiScannerContext
-
onTableRow
public void onTableRow(WikiParameters params)
Description copied from interface:IWikiScannerContextExplicitly 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 methodsIWikiScannerContext.beginTableCell(boolean)orIWikiScannerContext.beginTableRow(boolean, WikiParameters, WikiParameters)should be used.- Specified by:
onTableRowin interfaceIWikiScannerContext
-
onVerbatim
public void onVerbatim(String str, boolean inline)
- Specified by:
onVerbatimin interfaceIWikiScannerContext- See Also:
WikiScannerContext.onVerbatim(java.lang.String, boolean)
-
onVerbatim
public void onVerbatim(String str, boolean inline, WikiParameters params)
- Specified by:
onVerbatimin interfaceIWikiScannerContext
-
onVerbatim
public void onVerbatim(String str, WikiParameters params)
Waiting for following events to know if the verbatim is inline or not.- Specified by:
onVerbatimin interfaceIWikiScannerContext
-
onWord
public void onWord(String str)
- Specified by:
onWordin interfaceIWikiScannerContext
-
-