Interface HTMLTableElement
- All Superinterfaces:
Element, HTMLElement, Node
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.
See also the Document Object Model (DOM) Level 2 Specification.
- Since:
- 1.4, DOM Level 2
-
Field Summary
Fields declared in interface 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
Modifier and TypeFieldDescriptionstatic final short
The node is anAttr
.static final short
The node is aCDATASection
.static final short
The node is aComment
.static final short
The node is aDocumentFragment
.static final short
The node is aDocument
.static final short
The node is contained by the reference node.static final short
The node contains the reference node.static final short
The two nodes are disconnected.static final short
The node follows the reference node.static final short
The determination of preceding versus following is implementation-specific.static final short
The second node precedes the reference node.static final short
The node is aDocumentType
.static final short
The node is anElement
.static final short
The node is anEntity
.static final short
The node is anEntityReference
.static final short
The node is aNotation
.static final short
The node is aProcessingInstruction
.static final short
The node is aText
node. -
Method Summary
Modifier and TypeMethodDescriptionCreate a new table caption object or return an existing one.Create a table footer row or return an existing one.Create a table header row or return an existing one.void
Delete the table caption, if one exists.void
deleteRow
(int index) Delete a table row.void
Delete the footer from the table, if one exists.void
Delete the header from the table, if one exists.getAlign()
Specifies the table's position with respect to the rest of the document.Cell background color.The width of the border around the table.Returns the table'sCAPTION
, or void if none exists.Specifies the horizontal and vertical space between cell content and cell borders.Specifies the horizontal and vertical separation between cells.getFrame()
Specifies which external table borders to render.getRows()
Returns a collection of all the rows in the table, including all inTHEAD
,TFOOT
, allTBODY
elements.getRules()
Specifies which internal table borders to render.Description about the purpose or structure of a table.Returns a collection of the defined table bodies.getTFoot()
Returns the table'sTFOOT
, ornull
if none exists.getTHead()
Returns the table'sTHEAD
, ornull
if none exists.getWidth()
Specifies the desired table width.insertRow
(int index) Insert a new empty row in the table.void
void
setBgColor
(String bgColor) void
void
setCaption
(HTMLTableCaptionElement caption) void
setCellPadding
(String cellPadding) void
setCellSpacing
(String cellSpacing) void
void
void
setSummary
(String summary) void
setTFoot
(HTMLTableSectionElement tFoot) void
setTHead
(HTMLTableSectionElement tHead) void
Methods declared in interface Element
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
Modifier and TypeMethodDescriptiongetAttribute
(String name) Retrieves an attribute value by name.getAttributeNode
(String name) Retrieves an attribute node by name.getAttributeNodeNS
(String namespaceURI, String localName) Retrieves anAttr
node by local name and namespace URI.getAttributeNS
(String namespaceURI, String localName) Retrieves an attribute value by local name and namespace URI.getElementsByTagName
(String name) Returns aNodeList
of all descendantElements
with a given tag name, in document order.getElementsByTagNameNS
(String namespaceURI, String localName) Returns aNodeList
of all the descendantElements
with a given local name and namespace URI in document order.The type information associated with this element.The name of the element.boolean
hasAttribute
(String name) Returnstrue
when an attribute with a given name is specified on this element or has a default value,false
otherwise.boolean
hasAttributeNS
(String namespaceURI, String localName) Returnstrue
when an attribute with a given local name and namespace URI is specified on this element or has a default value,false
otherwise.void
removeAttribute
(String name) Removes an attribute by name.removeAttributeNode
(Attr oldAttr) Removes the specified attribute node.void
removeAttributeNS
(String namespaceURI, String localName) Removes an attribute by local name and namespace URI.void
setAttribute
(String name, String value) Adds a new attribute.setAttributeNode
(Attr newAttr) Adds a new attribute node.setAttributeNodeNS
(Attr newAttr) Adds a new attribute.void
setAttributeNS
(String namespaceURI, String qualifiedName, String value) Adds a new attribute.void
setIdAttribute
(String name, boolean isId) If the parameterisId
istrue
, this method declares the specified attribute to be a user-determined ID attribute .void
setIdAttributeNode
(Attr idAttr, boolean isId) If the parameterisId
istrue
, this method declares the specified attribute to be a user-determined ID attribute .void
setIdAttributeNS
(String namespaceURI, String localName, boolean isId) If the parameterisId
istrue
, this method declares the specified attribute to be a user-determined ID attribute .Methods declared in interface HTMLElement
getClassName, getDir, getId, getLang, getTitle, setClassName, setDir, setId, setLang, setTitle
Modifier and TypeMethodDescriptionThe class attribute of the element.getDir()
Specifies the base direction of directionally neutral text and the directionality of tables.getId()
The element's identifier.getLang()
Language code defined in RFC 1766.getTitle()
The element's advisory title.void
setClassName
(String className) void
void
void
void
Methods declared in interface 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
Modifier and TypeMethodDescriptionappendChild
(Node newChild) Adds the nodenewChild
to the end of the list of children of this node.cloneNode
(boolean deep) Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.short
compareDocumentPosition
(Node other) Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the document order.ANamedNodeMap
containing the attributes of this node (if it is anElement
) ornull
otherwise.The absolute base URI of this node ornull
if the implementation wasn't able to obtain an absolute URI.ANodeList
that contains all children of this node.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 .The first child of this node.The last child of this node.Returns the local part of the qualified name of this node.The namespace URI of this node, ornull
if it is unspecified (see ).The node immediately following this node.The name of this node, depending on its type; see the table above.short
A code representing the type of the underlying object, as defined above.The value of this node, depending on its type; see the table above.TheDocument
object associated with this node.The parent of this node.The namespace prefix of this node, ornull
if it is unspecified.The node immediately preceding this node.This attribute returns the text content of this node and its descendants.getUserData
(String key) Retrieves the object associated to a key on a this node.boolean
Returns whether this node (if it is an element) has any attributes.boolean
Returns whether this node has any children.insertBefore
(Node newChild, Node refChild) Inserts the nodenewChild
before the existing child noderefChild
.boolean
isDefaultNamespace
(String namespaceURI) This method checks if the specifiednamespaceURI
is the default namespace or not.boolean
isEqualNode
(Node arg) Tests whether two nodes are equal.boolean
isSameNode
(Node other) Returns whether this node is the same node as the given one.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 .lookupNamespaceURI
(String prefix) Look up the namespace URI associated to the given prefix, starting from this node.lookupPrefix
(String namespaceURI) Look up the prefix associated to the given namespace URI, starting from this node.void
Puts allText
nodes in the full depth of the sub-tree underneath thisNode
, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesText
nodes, i.e., there are neither adjacentText
nodes nor emptyText
nodes.removeChild
(Node oldChild) Removes the child node indicated byoldChild
from the list of children, and returns it.replaceChild
(Node newChild, Node oldChild) Replaces the child nodeoldChild
withnewChild
in the list of children, and returns theoldChild
node.void
setNodeValue
(String nodeValue) The value of this node, depending on its type; see the table above.void
The namespace prefix of this node, ornull
if it is unspecified.void
setTextContent
(String textContent) This attribute returns the text content of this node and its descendants.setUserData
(String key, Object data, UserDataHandler handler) Associate an object to a key on this node.
-
Method Details
-
getCaption
HTMLTableCaptionElement getCaption()Returns the table'sCAPTION
, or void if none exists. -
setCaption
-
getTHead
HTMLTableSectionElement getTHead()Returns the table'sTHEAD
, ornull
if none exists. -
setTHead
-
getTFoot
HTMLTableSectionElement getTFoot()Returns the table'sTFOOT
, ornull
if none exists. -
setTFoot
-
getRows
HTMLCollection getRows()Returns a collection of all the rows in the table, including all inTHEAD
,TFOOT
, allTBODY
elements. -
getTBodies
HTMLCollection getTBodies()Returns a collection of the defined table bodies. -
getAlign
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. -
setAlign
-
getBgColor
String getBgColor()Cell background color. See the bgcolor attribute definition in HTML 4.0. This attribute is deprecated in HTML 4.0. -
setBgColor
-
getBorder
String getBorder()The width of the border around the table. See the border attribute definition in HTML 4.0. -
setBorder
-
getCellPadding
String getCellPadding()Specifies the horizontal and vertical space between cell content and cell borders. See the cellpadding attribute definition in HTML 4.0. -
setCellPadding
-
getCellSpacing
String getCellSpacing()Specifies the horizontal and vertical separation between cells. See the cellspacing attribute definition in HTML 4.0. -
setCellSpacing
-
getFrame
String getFrame()Specifies which external table borders to render. See the frame attribute definition in HTML 4.0. -
setFrame
-
getRules
String getRules()Specifies which internal table borders to render. See the rules attribute definition in HTML 4.0. -
setRules
-
getSummary
String getSummary()Description about the purpose or structure of a table. See the summary attribute definition in HTML 4.0. -
setSummary
-
getWidth
String getWidth()Specifies the desired table width. See the width attribute definition in HTML 4.0. -
setWidth
-
createTHead
HTMLElement createTHead()Create a table header row or return an existing one.- Returns:
- A new table header element (
THEAD
).
-
deleteTHead
void deleteTHead()Delete the header from the table, if one exists. -
createTFoot
HTMLElement createTFoot()Create a table footer row or return an existing one.- Returns:
- A footer element (
TFOOT
).
-
deleteTFoot
void deleteTFoot()Delete the footer from the table, if one exists. -
createCaption
HTMLElement createCaption()Create a new table caption object or return an existing one.- Returns:
- A
CAPTION
element.
-
deleteCaption
void deleteCaption()Delete the table caption, if one exists. -
insertRow
Insert a new empty row in the table. The new row is inserted immediately before and in the same section as the currentindex
th row in the table. Ifindex
is equal to the number of rows, the new row is appended. In addition, when the table is empty the row is inserted into aTBODY
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.
-
deleteRow
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.
-