org.w3c.dom.html

Interface HTMLTableElement

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.
Method Summary
HTMLElementcreateCaption()
Create a new table caption object or return an existing one.
HTMLElementcreateTFoot()
Create a table footer row or return an existing one.
HTMLElementcreateTHead()
Create a table header row or return an existing one.
voiddeleteCaption()
Delete the table caption, if one exists.
voiddeleteRow(int index)
Delete a table row.
voiddeleteTFoot()
Delete the footer from the table, if one exists.
voiddeleteTHead()
Delete the header from the table, if one exists.
StringgetAlign()
Specifies the table's position with respect to the rest of the document.
StringgetBgColor()
Cell background color.
StringgetBorder()
The width of the border around the table.
HTMLTableCaptionElementgetCaption()
Returns the table's CAPTION, or void if none exists.
StringgetCellPadding()
Specifies the horizontal and vertical space between cell content andcell borders.
StringgetCellSpacing()
Specifies the horizontal and vertical separation between cells.
StringgetFrame()
Specifies which external table borders to render.
HTMLCollectiongetRows()
Returns a collection of all the rows in the table, including all in THEAD, TFOOT, all TBODY elements.
StringgetRules()
Specifies which internal table borders to render.
StringgetSummary()
Supplementary description about the purpose or structureof a table.
HTMLCollectiongetTBodies()
Returns a collection of the defined table bodies.
HTMLTableSectionElementgetTFoot()
Returns the table's TFOOT, or null if none exists.
HTMLTableSectionElementgetTHead()
Returns the table's THEAD, or null if none exists.
StringgetWidth()
Specifies the desired table width.
HTMLElementinsertRow(int index)
Insert a new empty row in the table.Note.
voidsetAlign(String align)
voidsetBgColor(String bgColor)
voidsetBorder(String border)
voidsetCaption(HTMLTableCaptionElement caption)
voidsetCellPadding(String cellPadding)
voidsetCellSpacing(String cellSpacing)
voidsetFrame(String frame)
voidsetRules(String rules)
voidsetSummary(String summary)
voidsetTFoot(HTMLTableSectionElement tFoot)
voidsetTHead(HTMLTableSectionElement tHead)
voidsetWidth(String width)

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)
Delete a table row.

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

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 andcell 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()
Supplementary description about the purpose or structureof 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)
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.

setAlign

public void setAlign(String align)

setBgColor

public void setBgColor(String bgColor)

setBorder

public void setBorder(String border)

setCaption

public void setCaption(HTMLTableCaptionElement caption)

setCellPadding

public void setCellPadding(String cellPadding)

setCellSpacing

public void setCellSpacing(String cellSpacing)

setFrame

public void setFrame(String frame)

setRules

public void setRules(String rules)

setSummary

public void setSummary(String summary)

setTFoot

public void setTFoot(HTMLTableSectionElement tFoot)

setTHead

public void setTHead(HTMLTableSectionElement tHead)

setWidth

public void setWidth(String width)