summaryrefslogtreecommitdiff
path: root/libjava/classpath/external/w3c_dom/org/w3c/dom/html2/HTMLTableElement.java
blob: ae15deb77d150308e450bf763fd80de263c445ac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
/*
 * Copyright (c) 2003 World Wide Web Consortium,
 * (Massachusetts Institute of Technology, Institut National de
 * Recherche en Informatique et en Automatique, Keio University). All
 * Rights Reserved. This program is distributed under the W3C's Software
 * Intellectual Property License. This program is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE.
 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
 */

package org.w3c.dom.html2;

import org.w3c.dom.DOMException;

/**
 * The create* and delete* methods on the table allow authors to construct and
 * modify tables. [<a href='http://www.w3.org/TR/1999/REC-html401-19991224'>HTML 4.01</a>] specifies that only one of each of the
 * <code>CAPTION</code>, <code>THEAD</code>, and <code>TFOOT</code> elements
 * may exist in a table. Therefore, if one exists, and the createTHead() or
 * createTFoot() method is called, the method returns the existing THead or
 * TFoot element. See the TABLE element definition in HTML 4.01.
 * <p>See also the <a href='http://www.w3.org/TR/2003/REC-DOM-Level-2-HTML-20030109'>Document Object Model (DOM) Level 2 HTML Specification</a>.
 */
public interface HTMLTableElement extends HTMLElement {
    /**
     * Returns the table's <code>CAPTION</code>, or void if none exists.
     * @version DOM Level 2
     */
    public HTMLTableCaptionElement getCaption();
    /**
     * Returns the table's <code>CAPTION</code>, or void if none exists.
     * @exception DOMException
     *    HIERARCHY_REQUEST_ERR: if the element is not a <code>CAPTION</code>.
     * @version DOM Level 2
     */
    public void setCaption(HTMLTableCaptionElement caption)
                          throws DOMException;

    /**
     * Returns the table's <code>THEAD</code>, or <code>null</code> if none
     * exists.
     * @version DOM Level 2
     */
    public HTMLTableSectionElement getTHead();
    /**
     * Returns the table's <code>THEAD</code>, or <code>null</code> if none
     * exists.
     * @exception DOMException
     *    HIERARCHY_REQUEST_ERR: if the element is not a <code>THEAD</code>.
     * @version DOM Level 2
     */
    public void setTHead(HTMLTableSectionElement tHead)
                          throws DOMException;

    /**
     * Returns the table's <code>TFOOT</code>, or <code>null</code> if none
     * exists.
     * @version DOM Level 2
     */
    public HTMLTableSectionElement getTFoot();
    /**
     * Returns the table's <code>TFOOT</code>, or <code>null</code> if none
     * exists.
     * @exception DOMException
     *    HIERARCHY_REQUEST_ERR: if the element is not a <code>TFOOT</code>.
     * @version DOM Level 2
     */
    public void setTFoot(HTMLTableSectionElement tFoot)
                          throws DOMException;

    /**
     * Returns a collection of all the rows in the table, including all in
     * <code>THEAD</code>, <code>TFOOT</code>, all <code>TBODY</code>
     * elements.
     */
    public HTMLCollection getRows();

    /**
     * Returns a collection of the table bodies (including implicit ones).
     */
    public HTMLCollection getTBodies();

    /**
     * Specifies the table's position with respect to the rest of the
     * document. See the align attribute definition in HTML 4.01. This
     * attribute is deprecated in HTML 4.01.
     */
    public String getAlign();
    /**
     * Specifies the table's position with respect to the rest of the
     * document. See the align attribute definition in HTML 4.01. This
     * attribute is deprecated in HTML 4.01.
     */
    public void setAlign(String align);

    /**
     * Cell background color. See the bgcolor attribute definition in HTML
     * 4.01. This attribute is deprecated in HTML 4.01.
     */
    public String getBgColor();
    /**
     * Cell background color. See the bgcolor attribute definition in HTML
     * 4.01. This attribute is deprecated in HTML 4.01.
     */
    public void setBgColor(String bgColor);

    /**
     * The width of the border around the table. See the border attribute
     * definition in HTML 4.01.
     */
    public String getBorder();
    /**
     * The width of the border around the table. See the border attribute
     * definition in HTML 4.01.
     */
    public void setBorder(String border);

    /**
     * Specifies the horizontal and vertical space between cell content and
     * cell borders. See the cellpadding attribute definition in HTML 4.01.
     */
    public String getCellPadding();
    /**
     * Specifies the horizontal and vertical space between cell content and
     * cell borders. See the cellpadding attribute definition in HTML 4.01.
     */
    public void setCellPadding(String cellPadding);

    /**
     * Specifies the horizontal and vertical separation between cells. See the
     * cellspacing attribute definition in HTML 4.01.
     */
    public String getCellSpacing();
    /**
     * Specifies the horizontal and vertical separation between cells. See the
     * cellspacing attribute definition in HTML 4.01.
     */
    public void setCellSpacing(String cellSpacing);

    /**
     * Specifies which external table borders to render. See the frame
     * attribute definition in HTML 4.01.
     */
    public String getFrame();
    /**
     * Specifies which external table borders to render. See the frame
     * attribute definition in HTML 4.01.
     */
    public void setFrame(String frame);

    /**
     * Specifies which internal table borders to render. See the rules
     * attribute definition in HTML 4.01.
     */
    public String getRules();
    /**
     * Specifies which internal table borders to render. See the rules
     * attribute definition in HTML 4.01.
     */
    public void setRules(String rules);

    /**
     * Description about the purpose or structure of a table. See the summary
     * attribute definition in HTML 4.01.
     */
    public String getSummary();
    /**
     * Description about the purpose or structure of a table. See the summary
     * attribute definition in HTML 4.01.
     */
    public void setSummary(String summary);

    /**
     * Specifies the desired table width. See the width attribute definition
     * in HTML 4.01.
     */
    public String getWidth();
    /**
     * Specifies the desired table width. See the width attribute definition
     * in HTML 4.01.
     */
    public void setWidth(String width);

    /**
     * Create a table header row or return an existing one.
     * @return A new table header element (<code>THEAD</code>).
     */
    public HTMLElement createTHead();

    /**
     * Delete the header from the table, if one exists.
     */
    public void deleteTHead();

    /**
     * Create a table footer row or return an existing one.
     * @return A footer element (<code>TFOOT</code>).
     */
    public HTMLElement createTFoot();

    /**
     * Delete the footer from the table, if one exists.
     */
    public void deleteTFoot();

    /**
     * Create a new table caption object or return an existing one.
     * @return A <code>CAPTION</code> element.
     */
    public HTMLElement createCaption();

    /**
     * Delete the table caption, if one exists.
     */
    public void deleteCaption();

    /**
     * Insert a new empty row in the table. The new row is inserted
     * immediately before and in the same section as the current
     * <code>index</code>th row in the table. If <code>index</code> is -1 or
     * equal to the number of rows, the new row is appended. In addition,
     * when the table is empty the row is inserted into a <code>TBODY</code>
     * which is created and inserted into the table.A table row cannot be
     * empty according to [<a href='http://www.w3.org/TR/1999/REC-html401-19991224'>HTML 4.01</a>].
     * @param index The row number where to insert a new row. This index
     *   starts from 0 and is relative to the logical order (not document
     *   order) of all the rows contained inside the table.
     * @return The newly created row.
     * @exception DOMException
     *   INDEX_SIZE_ERR: Raised if the specified index is greater than the
     *   number of rows or if the index is a negative number other than -1.
     * @version DOM Level 2
     */
    public HTMLElement insertRow(int index)
                                 throws DOMException;

    /**
     * Delete a table row.
     * @param index The index of the row to be deleted. This index starts
     *   from 0 and is relative to the logical order (not document order) of
     *   all the rows contained inside the table. If the index is -1 the
     *   last row in the table is deleted.
     * @exception DOMException
     *   INDEX_SIZE_ERR: Raised if the specified index is greater than or
     *   equal to the number of rows or if the index is a negative number
     *   other than -1.
     * @version DOM Level 2
     */
    public void deleteRow(int index)
                          throws DOMException;

}