1 /*

     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     3  *

     4  * This code is free software; you can redistribute it and/or modify it

     5  * under the terms of the GNU General Public License version 2 only, as

     6  * published by the Free Software Foundation.  Sun designates this

     7  * particular file as subject to the "Classpath" exception as provided

     8  * by Sun in the LICENSE file that accompanied this code.

     9  *

    10  * This code is distributed in the hope that it will be useful, but WITHOUT

    11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    13  * version 2 for more details (a copy is included in the LICENSE file that

    14  * accompanied this code).

    15  *

    16  * You should have received a copy of the GNU General Public License version

    17  * 2 along with this work; if not, write to the Free Software Foundation,

    18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    19  *

    20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    21  * CA 95054 USA or visit www.sun.com if you need additional information or

    22  * have any questions.

    23  */

    24 

    25 /*

    26  * This file is available under and governed by the GNU General Public

    27  * License version 2 only, as published by the Free Software Foundation.

    28  * However, the following notice accompanied the original version of this

    29  * file and, per its terms, should not be removed:

    30  *

    31  * Copyright (c) 2000 World Wide Web Consortium,

    32  * (Massachusetts Institute of Technology, Institut National de

    33  * Recherche en Informatique et en Automatique, Keio University). All

    34  * Rights Reserved. This program is distributed under the W3C's Software

    35  * Intellectual Property License. This program is distributed in the

    36  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even

    37  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR

    38  * PURPOSE. See W3C License http://www.w3.org/Consortium/Legal/ for more

    39  * details.

    40  */

    41 

    42 package org.w3c.dom.html;

    43 

    44 import org.w3c.dom.DOMException;

    45 

    46 /**

    47  *  A row in a table. See the  TR element definition in HTML 4.0.

    48  * <p>See also the <a href='http://www.w3.org/TR/2000/CR-DOM-Level-2-20000510'>Document Object Model (DOM) Level 2 Specification</a>.

    49  */

    50 public interface HTMLTableRowElement extends HTMLElement {

    51     /**

    52      *  The index of this row, relative to the entire table, starting from 0.

    53      * This is in document tree order and not display order. The

    54      * <code>rowIndex</code> does not take into account sections (

    55      * <code>THEAD</code> , <code>TFOOT</code> , or <code>TBODY</code> )

    56      * within the table.

    57      */

    58     public int getRowIndex();

    59 

    60     /**

    61      *  The index of this row, relative to the current section (

    62      * <code>THEAD</code> , <code>TFOOT</code> , or <code>TBODY</code> ),

    63      * starting from 0.

    64      */

    65     public int getSectionRowIndex();

    66 

    67     /**

    68      *  The collection of cells in this row.

    69      */

    70     public HTMLCollection getCells();

    71 

    72     /**

    73      *  Horizontal alignment of data within cells of this row. See the  align

    74      * attribute definition in HTML 4.0.

    75      */

    76     public String getAlign();

    77     public void setAlign(String align);

    78 

    79     /**

    80      *  Background color for rows. See the  bgcolor attribute definition in

    81      * HTML 4.0. This attribute is deprecated in HTML 4.0.

    82      */

    83     public String getBgColor();

    84     public void setBgColor(String bgColor);

    85 

    86     /**

    87      *  Alignment character for cells in a column. See the  char attribute

    88      * definition in HTML 4.0.

    89      */

    90     public String getCh();

    91     public void setCh(String ch);

    92 

    93     /**

    94      *  Offset of alignment character. See the  charoff attribute definition

    95      * in HTML 4.0.

    96      */

    97     public String getChOff();

    98     public void setChOff(String chOff);

    99 

   100     /**

   101      *  Vertical alignment of data within cells of this row. See the  valign

   102      * attribute definition in HTML 4.0.

   103      */

   104     public String getVAlign();

   105     public void setVAlign(String vAlign);

   106 

   107     /**

   108      *  Insert an empty <code>TD</code> cell into this row. If

   109      * <code>index</code> is equal to the number of cells, the new cell is

   110      * appended

   111      * @param index  The place to insert the cell, starting from 0.

   112      * @return  The newly created cell.

   113      * @exception DOMException

   114      *    INDEX_SIZE_ERR: Raised if the specified <code>index</code> is

   115      *   greater than the number of cells or if the index is negative.

   116      */

   117     public HTMLElement insertCell(int index)

   118                                   throws DOMException;

   119 

   120     /**

   121      *  Delete a cell from the current row.

   122      * @param index  The index of the cell to delete, starting from 0.

   123      * @exception DOMException

   124      *    INDEX_SIZE_ERR: Raised if the specified <code>index</code> is

   125      *   greater than or equal to the number of cells or if the index is

   126      *   negative.

   127      */

   128     public void deleteCell(int index)

   129                            throws DOMException;

   130 

   131 }