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

File IWemListenerTable.java

 

Code metrics

0
0
0
1
91
11
0
-
-
0
-

Classes

Class Line # Actions
IWemListenerTable 29 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;
21   
22    /**
23    * This interface re-groups all methods used to notify about tables and their
24    * structural elements.
25    *
26    * @version $Id: 2be8fee0722c291f9a00fc9689a3472e9cfe9198 $
27    * @since 4.0M1
28    */
 
29    public interface IWemListenerTable
30    {
31    /**
32    * This method notifies about the beginning of a new table in the document.
33    *
34    * @param params table parameters
35    * @see #endTable(WikiParameters)
36    */
37    void beginTable(WikiParameters params);
38   
39    /**
40    * This method is used to notify about the beginning of a new table cell.
41    *
42    * @param tableHead if this flag is <code>true</code> then the reported cell
43    * corresponds to the table head ("th" element); otherwise it should
44    * be considered as a normal table cell ("td" element).
45    * @param params parameters of this cell
46    * @see #endTableCell(boolean, WikiParameters)
47    */
48    void beginTableCell(boolean tableHead, WikiParameters params);
49   
50    /**
51    * This method is used to notify about the beginning of a new table row.
52    *
53    * @param params parameters of the row.
54    * @see #endTableRow(WikiParameters)
55    */
56    void beginTableRow(WikiParameters params);
57   
58    /**
59    * This method notifies about the end of a table in the document.
60    *
61    * @param params table parameters
62    * @see #beginTable(WikiParameters)
63    */
64    void endTable(WikiParameters params);
65   
66    /**
67    * This method is used to notify about the end of a table cell.
68    *
69    * @param tableHead if this flag is <code>true</code> then the reported cell
70    * corresponds to the table head ("th" element); otherwise it should
71    * be considered as a normal table cell ("td" element).
72    * @param params parameters of this cell
73    * @see #beginTableCell(boolean, WikiParameters)
74    */
75    void endTableCell(boolean tableHead, WikiParameters params);
76   
77    /**
78    * This method is used to notify about the end of a table row.
79    *
80    * @param params parameters of the row.
81    * @see #beginTableRow(WikiParameters)
82    */
83    void endTableRow(WikiParameters params);
84   
85    /**
86    * Notifies the table caption.
87    *
88    * @param str the content of the table caption
89    */
90    void onTableCaption(String str);
91    }