org.w3c.dom.html
Interface HTMLTableElement

All Superinterfaces:
Element, HTMLElement, Node

public interface HTMLTableElement
extends HTMLElement

The create* and delete* methods on the table allow authors to constructand modify tables. HTML 4.0 specifies that only one of each of the CAPTION, THEAD, and TFOOTelements may exist in a table. Therefore, if one exists, and thecreateTHead() or createTFoot() method is called, the method returnsthe existing THead or TFoot element. See the TABLE element definition in HTML 4.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.
 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 andcell 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()
          Supplementary description about the purpose or structureof a table.
 HTMLCollection getTBodies()
          Returns a collection of the defined table bodies.
 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.Note.
 void setAlign(java.lang.String align)
           
 void setBgColor(java.lang.String bgColor)
           
 void setBorder(java.lang.String border)
           
 void setCaption(HTMLTableCaptionElement caption)
           
 void setCellPadding(java.lang.String cellPadding)
           
 void setCellSpacing(java.lang.String cellSpacing)
           
 void setFrame(java.lang.String frame)
           
 void setRules(java.lang.String rules)
           
 void setSummary(java.lang.String summary)
           
 void setTFoot(HTMLTableSectionElement tFoot)
           
 void setTHead(HTMLTableSectionElement tHead)
           
 void setWidth(java.lang.String width)
           
 
Methods inherited from interface org.w3c.dom.html.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, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
 
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.


setCaption

void setCaption(HTMLTableCaptionElement caption)

getTHead

HTMLTableSectionElement getTHead()
Returns the table's THEAD, or null if none exists.


setTHead

void setTHead(HTMLTableSectionElement tHead)

getTFoot

HTMLTableSectionElement getTFoot()
Returns the table's TFOOT, or null if none exists.


setTFoot

void setTFoot(HTMLTableSectionElement tFoot)

getRows

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


getTBodies

HTMLCollection getTBodies()
Returns a collection of the defined table bodies.


getAlign

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.0. This attribute is deprecated in HTML 4.0.


setAlign

void setAlign(java.lang.String align)

getBgColor

java.lang.String getBgColor()
Cell background color. See the bgcolor attribute definition in HTML 4.0. This attribute is deprecated in HTML 4.0.


setBgColor

void setBgColor(java.lang.String bgColor)

getBorder

java.lang.String getBorder()
The width of the border around the table. See the border attribute definition in HTML 4.0.


setBorder

void setBorder(java.lang.String border)

getCellPadding

java.lang.String getCellPadding()
Specifies the horizontal and vertical space between cell content andcell borders. See the cellpadding attribute definition in HTML 4.0.


setCellPadding

void setCellPadding(java.lang.String cellPadding)

getCellSpacing

java.lang.String getCellSpacing()
Specifies the horizontal and vertical separation between cells. See the cellspacing attribute definition in HTML 4.0.


setCellSpacing

void setCellSpacing(java.lang.String cellSpacing)

getFrame

java.lang.String getFrame()
Specifies which external table borders to render. See the frame attribute definition in HTML 4.0.


setFrame

void setFrame(java.lang.String frame)

getRules

java.lang.String getRules()
Specifies which internal table borders to render. See the rules attribute definition in HTML 4.0.


setRules

void setRules(java.lang.String rules)

getSummary

java.lang.String getSummary()
Supplementary description about the purpose or structureof a table. See the summary attribute definition in HTML 4.0.


setSummary

void setSummary(java.lang.String summary)

getWidth

java.lang.String getWidth()
Specifies the desired table width. See the width attribute definition in HTML 4.0.


setWidth

void setWidth(java.lang.String width)

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

HTMLElement insertRow(int index)
Insert a new empty row in 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.
Returns:
The newly created row.

deleteRow

void deleteRow(int index)
Delete a table row.

Parameters:
index - The index of the row to be deleted.


Copyright 1999-2010 The Apache Software Foundation. All Rights Reserved.