org.w3c.dom.html2.HTMLTableSectionElement Maven / Gradle / Ivy

/*
 * 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 THEAD, TFOOT, and TBODY 
 * elements. 
 * See also the Document Object Model (DOM) Level 2 HTML Specification.
 */
public interface HTMLTableSectionElement extends HTMLElement {
    /**
     * Horizontal alignment of data in cells. See the align 
     * attribute for HTMLTheadElement for details. 
     */
    public String getAlign();
    /**
     * Horizontal alignment of data in cells. See the align 
     * attribute for HTMLTheadElement for details. 
     */
    public void setAlign(String align);

    /**
     * Alignment character for cells in a column. See the char attribute 
     * definition in HTML 4.01.
     */
    public String getCh();
    /**
     * Alignment character for cells in a column. See the char attribute 
     * definition in HTML 4.01.
     */
    public void setCh(String ch);

    /**
     * Offset of alignment character. See the charoff attribute definition in 
     * HTML 4.01.
     */
    public String getChOff();
    /**
     * Offset of alignment character. See the charoff attribute definition in 
     * HTML 4.01.
     */
    public void setChOff(String chOff);

    /**
     * Vertical alignment of data in cells. See the valign 
     * attribute for HTMLTheadElement for details. 
     */
    public String getVAlign();
    /**
     * Vertical alignment of data in cells. See the valign 
     * attribute for HTMLTheadElement for details. 
     */
    public void setVAlign(String vAlign);

    /**
     * The collection of rows in this table section. 
     */
    public HTMLCollection getRows();

    /**
     * Insert a row into this section. The new row is inserted immediately 
     * before the current indexth row in this section. If 
     * index is -1 or equal to the number of rows in this 
     * section, the new row is appended.
     * @param index The row number where to insert a new row. This index 
     *   starts from 0 and is relative only to the rows contained inside 
     *   this section, not all the rows in the table.
     * @return The newly created row.
     * @exception DOMException
     *   INDEX_SIZE_ERR: Raised if the specified index is greater than the 
     *   number of rows of if the index is a negative number other than -1.
     * @version DOM Level 2
     */
    public HTMLElement insertRow(int index)
                                 throws DOMException;

    /**
     * Delete a row from this section.
     * @param index The index of the row to be deleted, or -1 to delete the 
     *   last row. This index starts from 0 and is relative only to the rows 
     *   contained inside this section, not all the rows in the table.
     * @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;

}