Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
IWemListenerSimpleBlocks | 30 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.rendering.wikimodel; | |
21 | ||
22 | /** | |
23 | * This listener re-groups methods used to notify about simple block elements. | |
24 | * Each simple block element (like paragraphs) can not have other block elements | |
25 | * or documents. Some of them can contain only formatted in-line elements. | |
26 | * | |
27 | * @version $Id: 89e09a43237af2e9fdd787fa265c11416a9960bf $ | |
28 | * @since 4.0M1 | |
29 | */ | |
30 | public interface IWemListenerSimpleBlocks | |
31 | { | |
32 | /** | |
33 | * This method is used to notify about the beginning of a "typed" paragraph. | |
34 | * Some wiki syntaxes have special markups to define simple block elements | |
35 | * corresponding to "warnings", "info blocks" and so on. Blocks of this type | |
36 | * can have formatted inline elements. | |
37 | * | |
38 | * @param infoType the "type" of the special block | |
39 | * @param params parameters of this block | |
40 | * @see #endInfoBlock(String, WikiParameters) | |
41 | */ | |
42 | void beginInfoBlock(String infoType, WikiParameters params); | |
43 | ||
44 | /** | |
45 | * Begin of a simple paragraph. Paragraphs can contain only formatted inline | |
46 | * elements. | |
47 | * | |
48 | * @param params paragraph parameters | |
49 | * @see #endParagraph(WikiParameters) | |
50 | */ | |
51 | void beginParagraph(WikiParameters params); | |
52 | ||
53 | /** | |
54 | * This method is used to notify about the end of a "typed" paragraph. | |
55 | * | |
56 | * @param infoType the "type" of the special block | |
57 | * @param params parameters of this block | |
58 | * @see #beginInfoBlock(String, WikiParameters) | |
59 | */ | |
60 | void endInfoBlock(String infoType, WikiParameters params); | |
61 | ||
62 | /** | |
63 | * End of a simple paragraph. | |
64 | * | |
65 | * @param params paragraph parameters | |
66 | * @see #beginParagraph(WikiParameters) | |
67 | */ | |
68 | void endParagraph(WikiParameters params); | |
69 | ||
70 | /** | |
71 | * This method is used to notify about a sequence of empty lines. This event | |
72 | * can be interpreted as an "empty paragraph". | |
73 | * | |
74 | * @param count the number of empty lines found in the text | |
75 | */ | |
76 | void onEmptyLines(int count); | |
77 | ||
78 | /** | |
79 | * This method notifies horizontal lines defined in the text. | |
80 | * | |
81 | * @param params parameters of the horizontal line | |
82 | */ | |
83 | void onHorizontalLine(WikiParameters params); | |
84 | ||
85 | /** | |
86 | * This method notifies about a verbatim (pre-formatted) block defined in | |
87 | * the text | |
88 | * | |
89 | * @param str the content of the verbatim (pre-formatted) block | |
90 | * @param params parameters of the verbatim block | |
91 | */ | |
92 | void onVerbatimBlock(String str, WikiParameters params); | |
93 | } |