public interface IWemListenerInline
So a normal sequence of notifications is: * beginFormat(...) - onWord(...) - onSpace(...) - onReference(...) - onWord(...) - ... * endFormat(...) * beginFormat(...) - onWord(...) - ... * endFormat(...)All inline elements can be splitted in the following categories:
onNewLine()
, onSpace(String)
,
onWord(String)
and onSpecialSymbol(String)
. This methods cover "simple text" and in sum they are
used to represent all types of "natural" elements in the text - words, spaces, new lines and special symbols.
Using only these methods it is possible to cover all combinations of all unicode characters. Parsers use these
methods to notify about all non-interpreted symbols and their combinations. These methods calls can be considered
as the base of any text documents.onEscape(String)
, onLineBreak()
, onReference(String)
/
onReference(WikiReference)
, onVerbatimInline(String, WikiParameters)
Modifier and Type | Method and Description |
---|---|
void |
beginFormat(WikiFormat format)
This method is called at the beginning of a sequence of in-line elements having the specified formatting
parameters.
|
void |
endFormat(WikiFormat format)
This method is called to notify about the end of a sequence of in-line elements having common formatting
parameters.
|
void |
onEscape(String str)
Escaped symbols.
|
void |
onImage(String ref)
This method is called to notify that an free standing image was found in the parsed wiki document.
|
void |
onImage(WikiReference ref)
This method is called to notify that a structured reference was found in the text
|
void |
onLineBreak()
This method is called to notify about a forced line break found in the text.
|
void |
onNewLine()
This method is called to notify that the parsed block contains a new line sequence (
"\r\n" or "\r" or "\n" character sequence). |
void |
onReference(String ref)
This method is called to notify that an URI (an implicit reference) was found in the parsed wiki document.
|
void |
onReference(WikiReference ref)
This method is called to notify that a structured reference was found in the text
|
void |
onSpace(String str)
This method is called to notify about a sequence of space symbols (like
" " or "\t" symbols). |
void |
onSpecialSymbol(String str)
This method is called to notify about a sequence of special characters.
|
void |
onVerbatimInline(String str,
WikiParameters params)
This method is called to notify about not-interpreted in-line sequence of characters which should be represented
in the final text "as is".
|
void |
onWord(String str)
This method is called to notify about a "word" found in the document.
|
void beginFormat(WikiFormat format)
format
- the object defining formatting parameters of in-line elements.void endFormat(WikiFormat format)
format
- the formatting object defining how contained in-line elements should be formattedvoid onEscape(String str)
str
- the escaped sequence of charactersvoid onImage(String ref)
ref
- the reference the referencevoid onImage(WikiReference ref)
ref
- the reference the referencevoid onLineBreak()
onNewLine()
notification.onNewLine()
void onNewLine()
"\r\n"
or "\r"
or "\n"
character sequence). Note that the new line symbols are not the same as a forced line break
sequence notified by the onLineBreak()
event.void onReference(String ref)
ref
- the URIvoid onReference(WikiReference ref)
ref
- the reference the referencevoid onSpace(String str)
" "
or "\t"
symbols).str
- the sequence of space charactersonWord(String)
,
onSpecialSymbol(String)
,
onNewLine()
void onSpecialSymbol(String str)
The full list of possible special symbols:
"!", "\"", "#", "$", "%", "&", "'", "(",
")", "*", "+", ",", "-", ".", "/", ":",
";", "<", "=", ">", "?", "@", "[", "\\",
"]", "^", "_", "`", "{", "|", "}", "~"
str
- the sequence of special symbolsonSpace(String)
,
onWord(String)
,
onNewLine()
void onVerbatimInline(String str, WikiParameters params)
str
- the sequence of non-interpreted charactersparams
- the list of parameters for this eventvoid onWord(String str)
Words are formed by the all characters excluding the following ones:
"\t", "\n", "\r", " ",
"!", "\"", "#", "$", "%", "&", "'", "(",
")", "*", "+", ",", "-", ".", "/", ":",
";", "<", "=", ">", "?", "@", "[", "\\",
"]", "^", "_", "`", "{", "|", "}", "~"
str
- the sequence of characters forming a wordonSpace(String)
,
onSpecialSymbol(String)
,
onNewLine()
Copyright © 2004–2021 XWiki. All rights reserved.