APIdia Launch Partner
Top Description Methods
org.w3c.dom.html

public Interface HTMLTableElement

extends HTMLElement
Imports
org.w3c.dom.DOMException
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

Method Summary

Modifier and TypeMethod and Description
public HTMLElement

Returns:

A CAPTION element.
createCaption()

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

public HTMLElement

Returns:

A footer element (TFOOT ).
createTFoot()

Create a table footer row or return an existing one.

public HTMLElement

Returns:

A new table header element (THEAD ).
createTHead()

Create a table header row or return an existing one.

public void
deleteCaption()

Delete the table caption, if one exists.

public void
deleteRow(int
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.
index)

Delete a table row.

public void
deleteTFoot()

Delete the footer from the table, if one exists.

public void
deleteTHead()

Delete the header from the table, if one exists.

public String
getAlign()

Specifies the table's position with respect to the rest of the document.

public String
getBgColor()

Cell background color.

public String
getBorder()

The width of the border around the table.

public HTMLTableCaptionElement
getCaption()

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

public String
getCellPadding()

Specifies the horizontal and vertical space between cell content and cell borders.

public String
getCellSpacing()

Specifies the horizontal and vertical separation between cells.

public String
getFrame()

Specifies which external table borders to render.

public HTMLCollection
getRows()

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

public String
getRules()

Specifies which internal table borders to render.

public String
getSummary()

Description about the purpose or structure of a table.

public HTMLCollection
getTBodies()

Returns a collection of the defined table bodies.

public HTMLTableSectionElement
getTFoot()

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

public HTMLTableSectionElement
getTHead()

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

public String
getWidth()

Specifies the desired table width.

public HTMLElement

Returns:

The newly created row.
insertRow(int
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.
index)

Insert a new empty row in the table.

public void
setAlign(String align)

public void
setBgColor(String bgColor)

public void
setBorder(String border)

public void
setCaption(HTMLTableCaptionElement caption)

public void
setCellPadding(String cellPadding)

public void
setCellSpacing(String cellSpacing)

public void
setFrame(String frame)

public void
setRules(String rules)

public void
setSummary(String summary)

public void
setTFoot(HTMLTableSectionElement tFoot)

public void
setTHead(HTMLTableSectionElement tHead)

public void
setWidth(String width)

Inherited from org.w3c.dom.html.HTMLElement:
getClassNamegetDirgetIdgetLanggetTitlesetClassNamesetDirsetIdsetLangsetTitle

Method Detail

createCaptionback to summary
public HTMLElement createCaption()

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

Returns:HTMLElement

A CAPTION element.

createTFootback to summary
public HTMLElement createTFoot()

Create a table footer row or return an existing one.

Returns:HTMLElement

A footer element (TFOOT ).

createTHeadback to summary
public HTMLElement createTHead()

Create a table header row or return an existing one.

Returns:HTMLElement

A new table header element (THEAD ).

deleteCaptionback to summary
public void deleteCaption()

Delete the table caption, if one exists.

deleteRowback to summary
public void deleteRow(int index) throws DOMException

Delete a table row.

Parameters
index:int

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.

Exceptions
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.
deleteTFootback to summary
public void deleteTFoot()

Delete the footer from the table, if one exists.

deleteTHeadback to summary
public void deleteTHead()

Delete the header from the table, if one exists.

getAlignback to summary
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.

getBgColorback to summary
public String getBgColor()

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

getBorderback to summary
public String getBorder()

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

getCaptionback to summary
public HTMLTableCaptionElement getCaption()

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

getCellPaddingback to summary
public String getCellPadding()

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

getCellSpacingback to summary
public String getCellSpacing()

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

getFrameback to summary
public String getFrame()

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

getRowsback to summary
public HTMLCollection getRows()

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

getRulesback to summary
public String getRules()

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

getSummaryback to summary
public String getSummary()

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

getTBodiesback to summary
public HTMLCollection getTBodies()

Returns a collection of the defined table bodies.

getTFootback to summary
public HTMLTableSectionElement getTFoot()

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

getTHeadback to summary
public HTMLTableSectionElement getTHead()

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

getWidthback to summary
public String getWidth()

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

insertRowback to summary
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:int

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:HTMLElement

The newly created row.

Exceptions
DOMException:
INDEX_SIZE_ERR: Raised if the specified index is greater than the number of rows or if the index is negative.
setAlignback to summary
public void setAlign(String align)
setBgColorback to summary
public void setBgColor(String bgColor)
setBorderback to summary
public void setBorder(String border)
setCaptionback to summary
public void setCaption(HTMLTableCaptionElement caption)
setCellPaddingback to summary
public void setCellPadding(String cellPadding)
setCellSpacingback to summary
public void setCellSpacing(String cellSpacing)
setFrameback to summary
public void setFrame(String frame)
setRulesback to summary
public void setRules(String rules)
setSummaryback to summary
public void setSummary(String summary)
setTFootback to summary
public void setTFoot(HTMLTableSectionElement tFoot)
setTHeadback to summary
public void setTHead(HTMLTableSectionElement tHead)
setWidthback to summary
public void setWidth(String width)