Module jdk.xml.dom
Package 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.

    Since:
    1.4, DOM Level 2

    • Method Detail

      • 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

        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​(String align)

      • getBgColor

        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​(String bgColor)

      • getBorder

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

      • setBorder

        void setBorder​(String border)

      • 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

        void setCellPadding​(String cellPadding)

      • getCellSpacing

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

      • setCellSpacing

        void setCellSpacing​(String cellSpacing)

      • getFrame

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

      • setFrame

        void setFrame​(String frame)

      • getRules

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

      • setRules

        void setRules​(String rules)

      • getSummary

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

      • setSummary

        void setSummary​(String summary)

      • getWidth

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

      • setWidth

        void setWidth​(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)
               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.

      • deleteRow

        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.