1 /*
2  * Copyright (c) 2003 World Wide Web Consortium,
3  * (Massachusetts Institute of Technology, Institut National de
4  * Recherche en Informatique et en Automatique, Keio University). All
5  * Rights Reserved. This program is distributed under the W3C's Software
6  * Intellectual Property License. This program is distributed in the
7  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
8  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
9  * PURPOSE.
10  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
11  */
12 
13 package org.w3c.dom.html2;
14 
15 import org.w3c.dom.DOMException;
16 
17 /**
18  * A row in a table. See the TR element definition in HTML 4.01.
19  * <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>.
20  */
21 public interface HTMLTableRowElement extends HTMLElement {
22     /**
23      * This is in logical order and not in document order. The
24      * <code>rowIndex</code> does take into account sections (
25      * <code>THEAD</code>, <code>TFOOT</code>, or <code>TBODY</code>) within
26      * the table, placing <code>THEAD</code> rows first in the index,
27      * followed by <code>TBODY</code> rows, followed by <code>TFOOT</code>
28      * rows.
29      * @version DOM Level 2
30      */
getRowIndex()31     public int getRowIndex();
32 
33     /**
34      * The index of this row, relative to the current section (
35      * <code>THEAD</code>, <code>TFOOT</code>, or <code>TBODY</code>),
36      * starting from 0.
37      * @version DOM Level 2
38      */
getSectionRowIndex()39     public int getSectionRowIndex();
40 
41     /**
42      * The collection of cells in this row.
43      * @version DOM Level 2
44      */
getCells()45     public HTMLCollection getCells();
46 
47     /**
48      * Horizontal alignment of data within cells of this row. See the align
49      * attribute definition in HTML 4.01.
50      */
getAlign()51     public String getAlign();
52     /**
53      * Horizontal alignment of data within cells of this row. See the align
54      * attribute definition in HTML 4.01.
55      */
setAlign(String align)56     public void setAlign(String align);
57 
58     /**
59      * Background color for rows. See the bgcolor attribute definition in HTML
60      * 4.01. This attribute is deprecated in HTML 4.01.
61      */
getBgColor()62     public String getBgColor();
63     /**
64      * Background color for rows. See the bgcolor attribute definition in HTML
65      * 4.01. This attribute is deprecated in HTML 4.01.
66      */
setBgColor(String bgColor)67     public void setBgColor(String bgColor);
68 
69     /**
70      * Alignment character for cells in a column. See the char attribute
71      * definition in HTML 4.01.
72      */
getCh()73     public String getCh();
74     /**
75      * Alignment character for cells in a column. See the char attribute
76      * definition in HTML 4.01.
77      */
setCh(String ch)78     public void setCh(String ch);
79 
80     /**
81      * Offset of alignment character. See the charoff attribute definition in
82      * HTML 4.01.
83      */
getChOff()84     public String getChOff();
85     /**
86      * Offset of alignment character. See the charoff attribute definition in
87      * HTML 4.01.
88      */
setChOff(String chOff)89     public void setChOff(String chOff);
90 
91     /**
92      * Vertical alignment of data within cells of this row. See the valign
93      * attribute definition in HTML 4.01.
94      */
getVAlign()95     public String getVAlign();
96     /**
97      * Vertical alignment of data within cells of this row. See the valign
98      * attribute definition in HTML 4.01.
99      */
setVAlign(String vAlign)100     public void setVAlign(String vAlign);
101 
102     /**
103      * Insert an empty <code>TD</code> cell into this row. If
104      * <code>index</code> is -1 or equal to the number of cells, the new
105      * cell is appended.
106      * @param index The place to insert the cell, starting from 0.
107      * @return The newly created cell.
108      * @exception DOMException
109      *   INDEX_SIZE_ERR: Raised if the specified <code>index</code> is greater
110      *   than the number of cells or if the index is a negative number other
111      *   than -1.
112      * @version DOM Level 2
113      */
insertCell(int index)114     public HTMLElement insertCell(int index)
115                                   throws DOMException;
116 
117     /**
118      * Delete a cell from the current row.
119      * @param index The index of the cell to delete, starting from 0. If the
120      *   index is -1 the last cell in the row is deleted.
121      * @exception DOMException
122      *   INDEX_SIZE_ERR: Raised if the specified <code>index</code> is greater
123      *   than or equal to the number of cells or if the index is a negative
124      *   number other than -1.
125      * @version DOM Level 2
126      */
deleteCell(int index)127     public void deleteCell(int index)
128                            throws DOMException;
129 
130 }
131