This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

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

Field Summary
 
Fields inherited from class 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 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.
 String
getWidth()

          Specifies the desired table width.
 HTMLElement
insertRow(int index)

          Insert a new empty row in the table.
 void
setAlign(String align)

          
 void
setBgColor(String bgColor)

          
 void
setBorder(String border)

          
 void
setCaption(HTMLTableCaptionElement caption)

          
 void
setCellPadding(String cellPadding)

          
 void
setCellSpacing(String cellSpacing)

          
 void
setFrame(String frame)

          
 void
setRules(String rules)

          
 void
setSummary(String summary)

          
 void
setTFoot(HTMLTableSectionElement tFoot)

          
 void
setTHead(HTMLTableSectionElement tHead)

          
 void
setWidth(String width)

          
 
Methods inherited from class org.w3c.dom.html.HTMLElement
getClassName, getDir, getId, getLang, getTitle, setClassName, setDir, setId, setLang, setTitle
 
Methods inherited from class 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 class 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

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

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

getBgColor

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

getBorder

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

getCaption

public HTMLTableCaptionElement getCaption()
Returns the table's CAPTION , or void if none exists.

getCellPadding

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

getCellSpacing

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

getFrame

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

getRows

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

getRules

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

getSummary

public String getSummary()
Description about the purpose or structure of a table. See the summary attribute definition in HTML 4.0.

getTBodies

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

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 String getWidth()
Specifies the desired table width. See the width attribute definition in HTML 4.0.

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

setAlign

public void setAlign(String align)
Parameters:
align

setBgColor

public void setBgColor(String bgColor)
Parameters:
bgColor

setBorder

public void setBorder(String border)
Parameters:
border

setCaption

public void setCaption(HTMLTableCaptionElement caption)
Parameters:
caption

setCellPadding

public void setCellPadding(String cellPadding)
Parameters:
cellPadding

setCellSpacing

public void setCellSpacing(String cellSpacing)
Parameters:
cellSpacing

setFrame

public void setFrame(String frame)
Parameters:
frame

setRules

public void setRules(String rules)
Parameters:
rules

setSummary

public void setSummary(String summary)
Parameters:
summary

setTFoot

public void setTFoot(HTMLTableSectionElement tFoot)
Parameters:
tFoot

setTHead

public void setTHead(HTMLTableSectionElement tHead)
Parameters:
tHead

setWidth

public void setWidth(String width)
Parameters:
width
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.