org.w3c.dom.html.HTMLTableRowElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dragome-js-jre Show documentation
Dragome SDK module: js-jre
There is a newer version: 0.96-beta4
/*
    GNU LESSER GENERAL PUBLIC LICENSE
    Copyright (C) 2006 The Lobo Project

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library 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 the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    Contact info: [email protected]
*/
/*
 * 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.html;

import org.w3c.dom.DOMException;

/**
 * A row in a table. See the TR element definition in HTML 4.01.
 * See also the Document Object Model (DOM) Level 2 HTML Specification.
 */
public interface HTMLTableRowElement extends HTMLElement
{
	/**
	 * This is in logical order and not in document order. The 
	 * rowIndex does take into account sections (
	 * THEAD, TFOOT, or TBODY) within 
	 * the table, placing THEAD rows first in the index, 
	 * followed by TBODY rows, followed by TFOOT 
	 * rows.
	 * @version DOM Level 2
	 */
	public int getRowIndex();

	/**
	 * The index of this row, relative to the current section (
	 * THEAD, TFOOT, or TBODY), 
	 * starting from 0.
	 * @version DOM Level 2
	 */
	public int getSectionRowIndex();

	/**
	 * The collection of cells in this row. 
	 * @version DOM Level 2
	 */
	public HTMLCollection getCells();

	/**
	 * Horizontal alignment of data within cells of this row. See the align 
	 * attribute definition in HTML 4.01.
	 */
	public String getAlign();
	/**
	 * Horizontal alignment of data within cells of this row. See the align 
	 * attribute definition in HTML 4.01.
	 */
	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 within cells of this row. See the valign 
	 * attribute definition in HTML 4.01.
	 */
	public String getVAlign();
	/**
	 * Vertical alignment of data within cells of this row. See the valign 
	 * attribute definition in HTML 4.01.
	 */
	public void setVAlign(String vAlign);

	/**
	 * Insert an empty TD cell into this row. If 
	 * index is -1 or equal to the number of cells, the new 
	 * cell is appended.
	 * @param index The place to insert the cell, starting from 0.
	 * @return The newly created cell.
	 * @exception DOMException
	 *   INDEX_SIZE_ERR: Raised if the specified index is greater 
	 *   than the number of cells or if the index is a negative number other 
	 *   than -1.
	 * @version DOM Level 2
	 */
	public HTMLElement insertCell(int index) throws DOMException;

	/**
	 * Delete a cell from the current row.
	 * @param index The index of the cell to delete, starting from 0. If the 
	 *   index is -1 the last cell in the row is deleted.
	 * @exception DOMException
	 *   INDEX_SIZE_ERR: Raised if the specified index is greater 
	 *   than or equal to the number of cells or if the index is a negative 
	 *   number other than -1.
	 * @version DOM Level 2
	 */
	public void deleteCell(int index) throws DOMException;

}