info.bliki.wiki.model

Interface IEventListener

All Known Implementing Classes:

DefaultEventListener

public interface IEventListener

A wiki event listener which will trigger the on.... event methods during the parsing process.

Method Summary

Modifier and Type	Method and Description
void	onHeader(char[] src, int startPosition, int endPosition, int rawStart, int rawEnd, int level) Notify the listener about a parsed header.
void	onTemplate(char[] src, int rawStart, int rawEnd) Notify the listener about a parsed template.
void	onWikiLink(char[] src, int rawStart, int rawEnd, String suffix) Notify the listener about a parsed wiki link.

Method Detail

onHeader

void onHeader(char[] src,
              int startPosition,
              int endPosition,
              int rawStart,
              int rawEnd,
              int level)

Notify the listener about a parsed header.

Parameters:

src - the currently parsed raw wikitext character array

startPosition - the start offset of the wiki head including the wiki head start

endPosition - the end offset of the wiki head including the wiki head end tags + 1.

rawStart - the start offset of the wiki head excluding the wiki head start

rawEnd - the end offset of the wiki head excluding the wiki head end tags

level - the header level (i.e. == gives level 2; === gives level 3;==== gives level 4...)

onWikiLink

void onWikiLink(char[] src,
                int rawStart,
                int rawEnd,
                String suffix)

Notify the listener about a parsed wiki link.

Parameters:

src - the currently parsed raw wikitext character array

rawStart - the start offset of the wiki link excluding the wiki link start tags '[['

rawEnd - the end offset of the wiki link excluding the wiki link end tags ']]'

suffix - a suffix string eventually written directly behind the wiki link (useful for plurals). Example:

 Dolphins are [[aquatic mammal]]s that are closely related to [[whale]]s and [[porpoise]]s.
 

onTemplate

void onTemplate(char[] src,
                int rawStart,
                int rawEnd)

Notify the listener about a parsed template.

Parameters:

src - the currently parsed raw wikitext character array

rawStart - the start offset of the wiki link excluding the wiki template start tags '{{'

rawEnd - the end offset of the wiki link excluding the wiki template end tags '}}'