Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

HTMLTableElement

implements HTMLElement

org.w3c.dom.html.HTMLTableElement

Class Overview

The create* and delete* methods on the table allow authors to construct and modify tables. HTML 4.0 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.0.

Summary

[Expand]

Inherited Constants

From interface org.w3c.dom.Node

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

[Expand]

Inherited Methods

From interface org.w3c.dom.Element

abstract String	getAttribute(String name) Retrieves an attribute value by name.
abstract String	getAttributeNS(String namespaceURI, String localName) Retrieves an attribute value by local name and namespace URI.
abstract Attr	getAttributeNode(String name) Retrieves an attribute node by name.
abstract Attr	getAttributeNodeNS(String namespaceURI, String localName) Retrieves an `Attr` node by local name and namespace URI.
abstract NodeList	getElementsByTagName(String name) Returns a `NodeList` of all descendant `Elements` with a given tag name, in document order.
abstract NodeList	getElementsByTagNameNS(String namespaceURI, String localName) Returns a `NodeList` of all the descendant `Elements` with a given local name and namespace URI in document order.
abstract TypeInfo	getSchemaTypeInfo() The type information associated with this element.
abstract String	getTagName() The name of the element.
abstract boolean	hasAttribute(String name) Returns `true` when an attribute with a given name is specified on this element or has a default value, `false` otherwise.
abstract boolean	hasAttributeNS(String namespaceURI, String localName) Returns `true` when an attribute with a given local name and namespace URI is specified on this element or has a default value, `false` otherwise.
abstract void	removeAttribute(String name) Removes an attribute by name.
abstract void	removeAttributeNS(String namespaceURI, String localName) Removes an attribute by local name and namespace URI.
abstract Attr	removeAttributeNode(Attr oldAttr) Removes the specified attribute node.
abstract void	setAttribute(String name, String value) Adds a new attribute.
abstract void	setAttributeNS(String namespaceURI, String qualifiedName, String value) Adds a new attribute.
abstract Attr	setAttributeNode(Attr newAttr) Adds a new attribute node.
abstract Attr	setAttributeNodeNS(Attr newAttr) Adds a new attribute.
abstract void	setIdAttribute(String name, boolean isId) If the parameter `isId` is `true`, this method declares the specified attribute to be a user-determined ID attribute .
abstract void	setIdAttributeNS(String namespaceURI, String localName, boolean isId) If the parameter `isId` is `true`, this method declares the specified attribute to be a user-determined ID attribute .
abstract void	setIdAttributeNode(Attr idAttr, boolean isId) If the parameter `isId` is `true`, this method declares the specified attribute to be a user-determined ID attribute .

From interface org.w3c.dom.Node

abstract Node	appendChild(Node newChild) Adds the node `newChild` to the end of the list of children of this node.
abstract Node	cloneNode(boolean deep) Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
abstract short	compareDocumentPosition(Node other) Compares the reference node, i.e.
abstract NamedNodeMap	getAttributes() A `NamedNodeMap` containing the attributes of this node (if it is an `Element`) or `null` otherwise.
abstract String	getBaseURI() The absolute base URI of this node or `null` if the implementation wasn't able to obtain an absolute URI.
abstract NodeList	getChildNodes() A `NodeList` that contains all children of this node.
abstract Object	getFeature(String feature, String version) This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in .
abstract Node	getFirstChild() The first child of this node.
abstract Node	getLastChild() The last child of this node.
abstract String	getLocalName() Returns the local part of the qualified name of this node.
abstract String	getNamespaceURI() The namespace URI of this node, or `null` if it is unspecified (see ).
abstract Node	getNextSibling() The node immediately following this node.
abstract String	getNodeName() The name of this node, depending on its type; see the table above.
abstract short	getNodeType() A code representing the type of the underlying object, as defined above.
abstract String	getNodeValue() The value of this node, depending on its type; see the table above.
abstract Document	getOwnerDocument() The `Document` object associated with this node.
abstract Node	getParentNode() The parent of this node.
abstract String	getPrefix() The namespace prefix of this node, or `null` if it is unspecified.
abstract Node	getPreviousSibling() The node immediately preceding this node.
abstract String	getTextContent() This attribute returns the text content of this node and its descendants.
abstract Object	getUserData(String key) Retrieves the object associated to a key on a this node.
abstract boolean	hasAttributes() Returns whether this node (if it is an element) has any attributes.
abstract boolean	hasChildNodes() Returns whether this node has any children.
abstract Node	insertBefore(Node newChild, Node refChild) Inserts the node `newChild` before the existing child node `refChild`.
abstract boolean	isDefaultNamespace(String namespaceURI) This method checks if the specified `namespaceURI` is the default namespace or not.
abstract boolean	isEqualNode(Node arg) Tests whether two nodes are equal.
abstract boolean	isSameNode(Node other) Returns whether this node is the same node as the given one.
abstract boolean	isSupported(String feature, String version) Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in .
abstract String	lookupNamespaceURI(String prefix) Look up the namespace URI associated to the given prefix, starting from this node.
abstract String	lookupPrefix(String namespaceURI) Look up the prefix associated to the given namespace URI, starting from this node.
abstract void	normalize() Puts all `Text` nodes in the full depth of the sub-tree underneath this `Node`, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates `Text` nodes, i.e., there are neither adjacent `Text` nodes nor empty `Text` nodes.
abstract Node	removeChild(Node oldChild) Removes the child node indicated by `oldChild` from the list of children, and returns it.
abstract Node	replaceChild(Node newChild, Node oldChild) Replaces the child node `oldChild` with `newChild` in the list of children, and returns the `oldChild` node.
abstract void	setNodeValue(String nodeValue) The value of this node, depending on its type; see the table above.
abstract void	setPrefix(String prefix) The namespace prefix of this node, or `null` if it is unspecified.
abstract void	setTextContent(String textContent) This attribute returns the text content of this node and its descendants.
abstract Object	setUserData(String key, Object data, UserDataHandler handler) Associate an object to a key on this node.

From interface org.w3c.dom.html.HTMLElement

Public Methods

public abstract HTMLElement createCaption ()

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

Returns

A CAPTION element.

public abstract HTMLElement createTFoot ()

Create a table footer row or return an existing one.

Returns

A footer element (TFOOT ).

public abstract HTMLElement createTHead ()

Create a table header row or return an existing one.

Returns

A new table header element (THEAD ).

public abstract void deleteCaption ()

Delete the table caption, if one exists.

public abstract void deleteRow (int index)

Delete a table row.

Parameters

index	The index of the row to be deleted. This index starts from 0 and is relative to all the rows contained inside the table, regardless of section parentage.

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

public abstract void deleteTFoot ()

Delete the footer from the table, if one exists.

public abstract void deleteTHead ()

Delete the header from the table, if one exists.

public abstract String getAlign ()

Specifies the table's position with respect to the rest of the document. See the align attribute definition in HTML 4.0. This attribute is deprecated in HTML 4.0.

public abstract String getBgColor ()

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

public abstract String getBorder ()

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

public abstract HTMLTableCaptionElement getCaption ()

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

public abstract String getCellPadding ()

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

public abstract String getCellSpacing ()

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

public abstract String getFrame ()

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

public abstract HTMLCollection getRows ()

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

public abstract String getRules ()

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

public abstract String getSummary ()

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

public abstract HTMLCollection getTBodies ()

Returns a collection of the defined table bodies.

public abstract HTMLTableSectionElement getTFoot ()

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

public abstract HTMLTableSectionElement getTHead ()

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

public abstract String getWidth ()

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

public abstract HTMLElement insertRow (int index)

Insert a new empty row in the table. The new row is inserted immediately before and in the same section as the current index th row in the table. If index is 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.0 Recommendation.

Parameters

index	The row number where to insert a new row. This index starts from 0 and is relative to all the rows contained inside the table, regardless of section parentage.

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

Interfaces

HTMLTableElement

Class Overview

Summary

Public Methods

public abstract HTMLElement createCaption ()

Returns

public abstract HTMLElement createTFoot ()

Returns

public abstract HTMLElement createTHead ()

Returns

public abstract void deleteCaption ()

public abstract void deleteRow (int index)

Parameters

Throws

public abstract void deleteTFoot ()

public abstract void deleteTHead ()

public abstract String getAlign ()

public abstract String getBgColor ()

public abstract String getBorder ()

public abstract HTMLTableCaptionElement getCaption ()

public abstract String getCellPadding ()

public abstract String getCellSpacing ()

public abstract String getFrame ()

public abstract HTMLCollection getRows ()

public abstract String getRules ()

public abstract String getSummary ()

public abstract HTMLCollection getTBodies ()

public abstract HTMLTableSectionElement getTFoot ()

public abstract HTMLTableSectionElement getTHead ()

public abstract String getWidth ()

public abstract HTMLElement insertRow (int index)

Parameters

Returns

Throws

public abstract void setAlign (String align)

public abstract void setBgColor (String bgColor)

public abstract void setBorder (String border)

public abstract void setCaption (HTMLTableCaptionElement caption)

public abstract void setCellPadding (String cellPadding)

public abstract void setCellSpacing (String cellSpacing)

public abstract void setFrame (String frame)

public abstract void setRules (String rules)

public abstract void setSummary (String summary)

public abstract void setTFoot (HTMLTableSectionElement tFoot)

public abstract void setTHead (HTMLTableSectionElement tHead)

public abstract void setWidth (String width)