1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rendering.wikimodel.impl

File IWikiScannerContext.java

 

Code metrics

0
0
0
1
243
101
0
-
-
0
-

Classes

Class Line # Actions
IWikiScannerContext 31 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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.impl;
21   
22    import org.xwiki.rendering.wikimodel.IWemConstants;
23    import org.xwiki.rendering.wikimodel.WikiParameters;
24    import org.xwiki.rendering.wikimodel.WikiReference;
25    import org.xwiki.rendering.wikimodel.WikiStyle;
26   
27    /**
28    * @version $Id: b634b5abfd98098249626f87f4a42dadc208ff30 $
29    * @since 4.0M1
30    */
 
31    public interface IWikiScannerContext extends IWemConstants
32    {
33    void beginDocument();
34   
35    void beginDocument(WikiParameters params);
36   
37    void beginHeader(int level);
38   
39    void beginHeader(int level, WikiParameters params);
40   
41    void beginInfo(String type, WikiParameters params);
42   
43    void beginList();
44   
45    void beginList(WikiParameters params);
46   
47    void beginListItem(String item);
48   
49    void beginListItem(String item, WikiParameters params);
50   
51    void beginParagraph();
52   
53    void beginParagraph(WikiParameters params);
54   
55    void beginPropertyBlock(String property, boolean doc);
56   
57    void beginPropertyInline(String str);
58   
59    void beginQuot();
60   
61    void beginQuot(WikiParameters params);
62   
63    void beginQuotLine(int depth);
64   
65    void beginTable();
66   
67    void beginTable(WikiParameters params);
68   
69    void beginTableCell(boolean headCell);
70   
71    void beginTableCell(boolean headCell, WikiParameters params);
72   
73    /**
74    * Starts a new table row and adds the first cell to the table.
75    *
76    * @param headCell if this parameter is <code>true</code> then this method
77    * starts the header cell at the beginning of the line
78    */
79    void beginTableRow(boolean headCell);
80   
81    /**
82    * Starts a new table row and adds the first cell to the table.
83    *
84    * @param head if this parameter is <code>true</code> then this method
85    * starts the header cell at the beginning of the line
86    * @param rowParams parameters of the row
87    * @param cellParams parameters of the first row cell
88    */
89    void beginTableRow(
90    boolean head,
91    WikiParameters rowParams,
92    WikiParameters cellParams);
93   
94    /**
95    * Starts a new table row (but doesn't add a cell).
96    */
97    void beginTableRow(WikiParameters rowParams);
98   
99    boolean canApplyDefintionSplitter();
100   
101    boolean checkFormatStyle(WikiStyle style);
102   
103    void closeBlock();
104   
105    void endDocument();
106   
107    void endHeader();
108   
109    void endInfo();
110   
111    void endList();
112   
113    void endListItem();
114   
115    void endParagraph();
116   
117    void endPropertyBlock();
118   
119    void endPropertyInline();
120   
121    void endQuot();
122   
123    void endQuotLine();
124   
125    void endTable();
126   
127    void endTableCell();
128   
129    void endTableExplicit();
130   
131    void endTableRow();
132   
133    InlineState getInlineState();
134   
135    int getTableCellCounter();
136   
137    int getTableRowCounter();
138   
139    boolean isInDefinitionList();
140   
141    boolean isInDefinitionTerm();
142   
143    boolean isInHeader();
144   
145    boolean isInInlineProperty();
146   
147    boolean isInList();
148   
149    boolean isInTable();
150   
151    boolean isInTableCell();
152   
153    boolean isInTableRow();
154   
155    void onDefinitionListItemSplit();
156   
157    void onEmptyLines(int count);
158   
159    void onEscape(String str);
160   
161    void onExtensionBlock(String extensionName, WikiParameters params);
162   
163    void onExtensionInline(String extensionName, WikiParameters params);
164   
165    void onFormat(WikiParameters params);
166   
167    void onFormat(WikiStyle wikiStyle);
168   
169    void beginFormat(WikiParameters params);
170   
171    void beginFormat(WikiStyle wikiStyle);
172   
173    void endFormat(WikiParameters params);
174   
175    void endFormat(WikiStyle wikiStyle);
176   
177    /**
178    * @see WikiScannerContext#onFormat(org.xwiki.rendering.wikimodel.WikiStyle,
179    * boolean)
180    */
181    void onFormat(WikiStyle wikiStyle, boolean forceClose);
182   
183    void onHorizontalLine();
184   
185    void onHorizontalLine(WikiParameters params);
186   
187    void onImage(String ref);
188   
189    void onImage(WikiReference ref);
190   
191    void onLineBreak();
192   
193    void onMacro(String name, WikiParameters params, String content);
194   
195    void onMacro(
196    String macroName,
197    WikiParameters params,
198    String content,
199    boolean inline);
200   
201    void onMacroBlock(String macroName, WikiParameters params, String content);
202   
203    void onMacroInline(String macroName, WikiParameters params, String content);
204   
205    void onNewLine();
206   
207    void onQuotLine(int depth);
208   
209    void onReference(String ref);
210   
211    void onReference(WikiReference ref);
212   
213    void onSpace(String str);
214   
215    void onSpecialSymbol(String str);
216   
217    void onTableCaption(String str);
218   
219    void onTableCell(boolean headCell);
220   
221    void onTableCell(boolean head, WikiParameters cellParams);
222   
223    /**
224    * Explicitly starts a new table row. This method should not create a new
225    * cell at the beginning of the line. To automatically create the first row
226    * cell the methods {@link #beginTableCell(boolean)} or
227    * {@link #beginTableRow(boolean, WikiParameters, WikiParameters)} should be
228    * used.
229    */
230    void onTableRow(WikiParameters params);
231   
232    void onVerbatim(String str, WikiParameters params);
233   
234    /**
235    * @see WikiScannerContext#onVerbatim(java.lang.String,
236    * boolean)
237    */
238    void onVerbatim(String str, boolean inline);
239   
240    void onVerbatim(String str, boolean inline, WikiParameters params);
241   
242    void onWord(String str);
243    }