W3C DOM Level 2 version 1.0 - Java API: Interface HTMLTableElement

Overview

Package

Class

Tree

Index

Help

PREV CLASS NEXT CLASS

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.w3c.dom.html2
Interface HTMLTableElement

All Superinterfaces:: Element, HTMLElement, Node

public interface HTMLTableElement
extends HTMLElement

The create* and delete* methods on the table allow authors to construct and modify tables. [HTML 4.01] specifies that only one of each of the CAPTION, THEAD, and TFOOT 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.

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE,
CDATA_SECTION_NODE,
COMMENT_NODE,
DOCUMENT_FRAGMENT_NODE,
DOCUMENT_NODE,
DOCUMENT_TYPE_NODE,
ELEMENT_NODE,
ENTITY_NODE,
ENTITY_REFERENCE_NODE,
NOTATION_NODE,
PROCESSING_INSTRUCTION_NODE,
TEXT_NODE

Method Summary
`HTMLElement`	`createCaption()` Create a new table caption object or return an existing one.
`HTMLElement`	`createTFoot()` Create a table footer row or return an existing one.
`HTMLElement`	`createTHead()` Create a table header row or return an existing one.
`void`	`deleteCaption()` Delete the table caption, if one exists.
`void`	`deleteRow(int index)` Delete a table row.
`void`	`deleteTFoot()` Delete the footer from the table, if one exists.
`void`	`deleteTHead()` Delete the header from the table, if one exists.
`java.lang.String`	`getAlign()` Specifies the table's position with respect to the rest of the document.
`java.lang.String`	`getBgColor()` Cell background color.
`java.lang.String`	`getBorder()` The width of the border around the table.
`HTMLTableCaptionElement`	`getCaption()` Returns the table's `CAPTION`, or void if none exists.
`java.lang.String`	`getCellPadding()` Specifies the horizontal and vertical space between cell content and cell borders.
`java.lang.String`	`getCellSpacing()` Specifies the horizontal and vertical separation between cells.
`java.lang.String`	`getFrame()` Specifies which external table borders to render.
`HTMLCollection`	`getRows()` Returns a collection of all the rows in the table, including all in `THEAD`, `TFOOT`, all `TBODY` elements.
`java.lang.String`	`getRules()` Specifies which internal table borders to render.
`java.lang.String`	`getSummary()` Description about the purpose or structure of a table.
`HTMLCollection`	`getTBodies()` Returns a collection of the table bodies (including implicit ones).
`HTMLTableSectionElement`	`getTFoot()` Returns the table's `TFOOT`, or `null` if none exists.
`HTMLTableSectionElement`	`getTHead()` Returns the table's `THEAD`, or `null` if none exists.
`java.lang.String`	`getWidth()` Specifies the desired table width.
`HTMLElement`	`insertRow(int index)` Insert a new empty row in the table.
`void`	`setAlign(java.lang.String align)` Specifies the table's position with respect to the rest of the document.
`void`	`setBgColor(java.lang.String bgColor)` Cell background color.
`void`	`setBorder(java.lang.String border)` The width of the border around the table.
`void`	`setCaption(HTMLTableCaptionElement caption)` Returns the table's `CAPTION`, or void if none exists.
`void`	`setCellPadding(java.lang.String cellPadding)` Specifies the horizontal and vertical space between cell content and cell borders.
`void`	`setCellSpacing(java.lang.String cellSpacing)` Specifies the horizontal and vertical separation between cells.
`void`	`setFrame(java.lang.String frame)` Specifies which external table borders to render.
`void`	`setRules(java.lang.String rules)` Specifies which internal table borders to render.
`void`	`setSummary(java.lang.String summary)` Description about the purpose or structure of a table.
`void`	`setTFoot(HTMLTableSectionElement tFoot)` Returns the table's `TFOOT`, or `null` if none exists.
`void`	`setTHead(HTMLTableSectionElement tHead)` Returns the table's `THEAD`, or `null` if none exists.
`void`	`setWidth(java.lang.String width)` Specifies the desired table width.

Methods inherited from interface org.w3c.dom.html2.HTMLElement

getClassName,
getDir,
getId,
getLang,
getTitle,

setClassName, 
setDir, 
setId, 
setLang, 
setTitle

Methods inherited from interface org.w3c.dom.Element


getAttribute, 
getAttributeNode, 
getAttributeNodeNS, 
getAttributeNS, 
getElementsByTagName, 
getElementsByTagNameNS, getTagName,

hasAttribute, 
hasAttributeNS, 
removeAttribute, 
removeAttributeNode, 
removeAttributeNS, 
setAttribute, 
setAttributeNode, 
setAttributeNodeNS, 
setAttributeNS

Methods inherited from interface org.w3c.dom.Node

appendChild,
cloneNode,
getAttributes,
getChildNodes,
getFirstChild,
getLastChild,
getLocalName,
getNamespaceURI,
getNextSibling,
getNodeName,
getNodeType,
getNodeValue,
getOwnerDocument,
getParentNode,
getPrefix,
getPreviousSibling,
hasAttributes,
hasChildNodes,

insertBefore, 
isSupported, normalize,
removeChild,

replaceChild, setNodeValue,
setPrefix

Method Detail

createCaption

public HTMLElement createCaption()

Create a new table caption object or return an existing one.

Returns:: A CAPTION element.

createTFoot

public HTMLElement createTFoot()

Create a table footer row or return an existing one.

Returns:: A footer element (TFOOT).

createTHead

public HTMLElement createTHead()

Create a table header row or return an existing one.

Returns:: A new table header element (THEAD).

deleteCaption

public void deleteCaption()

Delete the table caption, if one exists.

deleteRow

public void deleteRow(int index)
               throws DOMException

Delete a table row.

Parameters:: 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.
Throws:: 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.

deleteTFoot

public void deleteTFoot()

Delete the footer from the table, if one exists.

deleteTHead

public void deleteTHead()

Delete the header from the table, if one exists.

getAlign

public java.lang.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.

getBgColor

public java.lang.String getBgColor()

Cell background color. See the bgcolor attribute definition in HTML 4.01. This attribute is deprecated in HTML 4.01.

getBorder

public java.lang.String getBorder()

The width of the border around the table. See the border attribute definition in HTML 4.01.

getCaption

public HTMLTableCaptionElement getCaption()

Returns the table's CAPTION, or void if none exists.

getCellPadding

public java.lang.String getCellPadding()

Specifies the horizontal and vertical space between cell content and cell borders. See the cellpadding attribute definition in HTML 4.01.

getCellSpacing

public java.lang.String getCellSpacing()

Specifies the horizontal and vertical separation between cells. See the cellspacing attribute definition in HTML 4.01.

getFrame

public java.lang.String getFrame()

Specifies which external table borders to render. See the frame attribute definition in HTML 4.01.

getRows

public HTMLCollection getRows()

Returns a collection of all the rows in the table, including all in THEAD, TFOOT, all TBODY elements.

getRules

public java.lang.String getRules()

Specifies which internal table borders to render. See the rules attribute definition in HTML 4.01.

getSummary

public java.lang.String getSummary()

Description about the purpose or structure of a table. See the summary attribute definition in HTML 4.01.

getTBodies

public HTMLCollection getTBodies()

Returns a collection of the table bodies (including implicit ones).

getTFoot

public HTMLTableSectionElement getTFoot()

Returns the table's TFOOT, or null if none exists.

getTHead

public HTMLTableSectionElement getTHead()

Returns the table's THEAD, or null if none exists.

getWidth

public java.lang.String getWidth()

Specifies the desired table width. See the width attribute definition in HTML 4.01.

insertRow

public HTMLElement insertRow(int index)
                      throws DOMException

Insert a new empty row in the table. The new row is inserted immediately before and in the same section as the current indexth row in the table. If index 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 TBODY which is created and inserted into the table.

Note: A table row cannot be empty according to [HTML 4.01].

Parameters:: 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.
Returns:: The newly created row.
Throws:: 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.

setAlign

public void setAlign(java.lang.String align)