org.w3c.dom.html2
Interface HTMLTableElement

All Superinterfaces:

Element, Node, HTMLElement

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.

See also the Document Object Model (DOM) Level 2 HTML Specification.

Since:

BlackBerry API 5.0.0

Field Summary

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, 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.
String	getAlign() Specifies the table's position with respect to the rest of the document.
String	getBgColor() Cell background color.
String	getBorder() The width of the border around the table.
HTMLTableCaptionElement	getCaption() Returns the table's CAPTION, or void if none exists.
String	getCellPadding() Specifies the horizontal and vertical space between cell content and cell borders.
String	getCellSpacing() Specifies the horizontal and vertical separation between cells.
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.
String	getRules() Specifies which internal table borders to render.
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.
String	getWidth() Specifies the desired table width.
HTMLElement	insertRow(int index) Insert a new empty row in the table.
void	setAlign(String align) Specifies the table's position with respect to the rest of the document.
void	setBgColor(String bgColor) Cell background color.
void	setBorder(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(String cellPadding) Specifies the horizontal and vertical space between cell content and cell borders.
void	setCellSpacing(String cellSpacing) Specifies the horizontal and vertical separation between cells.
void	setFrame(String frame) Specifies which external table borders to render.
void	setRules(String rules) Specifies which internal table borders to render.
void	setSummary(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(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, getAttributeNS, getAttributeNode, getAttributeNodeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNS, removeAttributeNode, setAttribute, setAttributeNS, setAttributeNode, setAttributeNodeNS, setIdAttribute, setIdAttributeNS, setIdAttributeNode

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Method Detail

getCaption

HTMLTableCaptionElement getCaption()

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

Since:

BlackBerry API 5.0.0

setCaption

void setCaption(HTMLTableCaptionElement caption)
                throws DOMException

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

Throws:

DOMException - HIERARCHY_REQUEST_ERR: if the element is not a CAPTION.

Since:

BlackBerry API 5.0.0

getTHead

HTMLTableSectionElement getTHead()

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

Since:

BlackBerry API 5.0.0

setTHead

void setTHead(HTMLTableSectionElement tHead)
              throws DOMException

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

Throws:

DOMException - HIERARCHY_REQUEST_ERR: if the element is not a THEAD.

Since:

BlackBerry API 5.0.0

getTFoot

HTMLTableSectionElement getTFoot()

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

Since:

BlackBerry API 5.0.0

setTFoot

void setTFoot(HTMLTableSectionElement tFoot)
              throws DOMException

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

Throws:

DOMException - HIERARCHY_REQUEST_ERR: if the element is not a TFOOT.

Since:

BlackBerry API 5.0.0

getRows

HTMLCollection getRows()

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

Since:

BlackBerry API 5.0.0

getTBodies

HTMLCollection getTBodies()

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

Since:

BlackBerry API 5.0.0

getAlign

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.

Since:

BlackBerry API 5.0.0

setAlign

void setAlign(String align)

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.

Since:

BlackBerry API 5.0.0

getBgColor

String getBgColor()

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

Since:

BlackBerry API 5.0.0

setBgColor

void setBgColor(String bgColor)

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

Since:

BlackBerry API 5.0.0

getBorder

String getBorder()

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

Since:

BlackBerry API 5.0.0

setBorder

void setBorder(String border)

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

Since:

BlackBerry API 5.0.0

getCellPadding

String getCellPadding()

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

Since:

BlackBerry API 5.0.0

setCellPadding

void setCellPadding(String cellPadding)

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

Since:

BlackBerry API 5.0.0

getCellSpacing

String getCellSpacing()

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

Since:

BlackBerry API 5.0.0

setCellSpacing

void setCellSpacing(String cellSpacing)

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

Since:

BlackBerry API 5.0.0

getFrame

String getFrame()

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

Since:

BlackBerry API 5.0.0

setFrame

void setFrame(String frame)

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

Since:

BlackBerry API 5.0.0

getRules

String getRules()

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

Since:

BlackBerry API 5.0.0

setRules

void setRules(String rules)

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

Since:

BlackBerry API 5.0.0

getSummary

String getSummary()

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

Since:

BlackBerry API 5.0.0

setSummary

void setSummary(String summary)

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

Since:

BlackBerry API 5.0.0

getWidth

String getWidth()

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

Since:

BlackBerry API 5.0.0

setWidth

void setWidth(String width)

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

Since:

BlackBerry API 5.0.0

createTHead

HTMLElement createTHead()

Create a table header row or return an existing one.

Returns:

A new table header element (THEAD).

Since:

BlackBerry API 5.0.0

deleteTHead

void deleteTHead()

Delete the header from the table, if one exists.

Since:

BlackBerry API 5.0.0

createTFoot

HTMLElement createTFoot()

Create a table footer row or return an existing one.

Returns:

A footer element (TFOOT).

Since:

BlackBerry API 5.0.0

deleteTFoot

void deleteTFoot()

Delete the footer from the table, if one exists.

Since:

BlackBerry API 5.0.0

createCaption

HTMLElement createCaption()

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

Returns:

A CAPTION element.

Since:

BlackBerry API 5.0.0

deleteCaption

void deleteCaption()

Delete the table caption, if one exists.

Since:

BlackBerry API 5.0.0

insertRow

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.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.

Since:

BlackBerry API 5.0.0

deleteRow

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.

Since:

BlackBerry API 5.0.0