Package org.w3c.dom.mathml

Interface MathMLTableElement

    • 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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void deleteRow​(long index)
      A convenience method to delete the row of the table at the specified index.
      java.lang.String getAlign()
      A string representing the vertical alignment of the table with the adjacent text.
      java.lang.String getAlignmentscope()
      A string consisting of the values true or false indicating, for each column, whether it can be used as an alignment scope.
      java.lang.String getColumnalign()
      A string representing the alignment of entries in each column, consisting of a space-separated sequence of alignment specifiers, each of which can have the following values: left, center, or right.
      java.lang.String getColumnlines()
      A string specifying whether and what kind of lines should be added between each column.
      java.lang.String getColumnspacing()
      A string consisting of a space-separated sequence of specifiers of the form number h-unit representing the space to be added between columns.
      java.lang.String getColumnwidth()
      A string consisting of a space-separated sequence of specifiers, each of which can have one of the following forms: auto, number h-unit, namedspace, or fit.
      java.lang.String getDisplaystyle()
      A string with the values true or false.
      java.lang.String getEqualcolumns()
      A string with the values true or false.
      java.lang.String getEqualrows()
      A string with the values true or false.
      java.lang.String getFrame()
      A string specifying a frame around the table.
      java.lang.String getFramespacing()
      A string of the form number h-unit number v-unit specifying the spacing between table and its frame.
      java.lang.String getGroupalign()
      A string specifying how the alignment groups within the cells of each row are to be aligned with the corresponding items above or below them in the same column.
      java.lang.String getMinlabelspacing()
      A string of the form number h-unit, specifying the minimum space between a label and the adjacent entry in the labeled row.
      MathMLTableRowElement getRow​(long index)
      A convenience method to retrieve the index-th row from the table.
      java.lang.String getRowalign()
      A string representing the alignment of entries in each row, consisting of a space-separated sequence of alignment specifiers, each of which can have the following values: top, bottom, center, baseline, or axis.
      java.lang.String getRowlines()
      A string specifying whether and what kind of lines should be added between each row.
      MathMLNodeList getRows()
      A MathMLNodeList consisting of MathMLTableRowElements and MathMLLabeledRowElements representing the rows of the table.
      java.lang.String getRowspacing()
      A string consisting of a space-separated sequence of specifiers of the form number v-unit representing the space to be added between rows.
      java.lang.String getSide()
      A string with the values left, right, leftoverlap, or rightoverlap.
      java.lang.String getWidth()
      A string that is either of the form number h-unit or is the string auto.
      MathMLLabeledRowElement insertEmptyLabeledRow​(long index)
      A convenience method to insert a new (empty) labeled row (mlabeledtr) in the table before the current index-th row.
      MathMLTableRowElement insertEmptyRow​(long index)
      A convenience method to insert a new (empty) row (mtr) in the table before the current index-th row.
      MathMLTableRowElement insertRow​(long index, MathMLTableRowElement newRow)
      A convenience method to insert the new row or labeled row (mtr or mlabeledtr) represented by newRow in the table before the current index-th row.
      MathMLTableRowElement removeRow​(long index)
      A convenience method to delete the row of the table at the specified index and return it to the caller.
      void setAlign​(java.lang.String align)
      setter for the align attribute.
      void setAlignmentscope​(java.lang.String alignmentscope)
      setter for the alignmentscope attribute.
      void setColumnalign​(java.lang.String columnalign)
      setter for the columnalign attribute.
      void setColumnlines​(java.lang.String columnlines)
      setter for the columnlines attribute.
      void setColumnspacing​(java.lang.String columnspacing)
      setter for the columnspacing attribute.
      void setColumnwidth​(java.lang.String columnwidth)
      setter for the columnwidth attribute.
      void setDisplaystyle​(java.lang.String displaystyle)
      setter for the displaystyle attribute.
      void setEqualcolumns​(java.lang.String equalcolumns)
      setter for the equalcolumns attribute.
      void setEqualrows​(java.lang.String equalrows)
      setter for the equalrows attribute.
      void setFrame​(java.lang.String frame)
      setter for the frame attribute.
      void setFramespacing​(java.lang.String framespacing)
      setter for the framespacing attribute.
      void setGroupalign​(java.lang.String groupalign)
      setter for the groupalign attribute.
      void setMinlabelspacing​(java.lang.String minlabelspacing)
      setter for the minlabelspacing attribute.
      MathMLTableRowElement setRow​(long index, MathMLTableRowElement newRow)
      A method to set the value of the row in the table at the specified index to the mtr or mlabeledtr represented by newRow.
      void setRowalign​(java.lang.String rowalign)
      setter for the rowalign attribute.
      void setRowlines​(java.lang.String rowlines)
      setter for the rowlines attribute.
      void setRowspacing​(java.lang.String rowspacing)
      setter for the rowspacing attribute.
      void setSide​(java.lang.String side)
      setter for the side attribute.
      void setWidth​(java.lang.String width)
      setter for the width attribute.

      • 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

      • getAlign

        java.lang.String getAlign()
        A string representing the vertical alignment of the table with the adjacent text. Allowed values are (top | bottom | center | baseline | axis)[rownumber], where rownumber is between 1 and n (for a table with n rows) or -1 and -n.
        Returns:
        value of the align attribute.

      • setAlign

        void setAlign​(java.lang.String align)
        setter for the align attribute.
        Parameters:
        align - new value for align.
        See Also:
        getAlign()

      • getRowalign

        java.lang.String getRowalign()
        A string representing the alignment of entries in each row, consisting of a space-separated sequence of alignment specifiers, each of which can have the following values: top, bottom, center, baseline, or axis.
        Returns:
        value of the rowalign attribute.

      • setRowalign

        void setRowalign​(java.lang.String rowalign)
        setter for the rowalign attribute.
        Parameters:
        rowalign - new value for rowalign.
        See Also:
        getRowalign()

      • getColumnalign

        java.lang.String getColumnalign()
        A string representing the alignment of entries in each column, consisting of a space-separated sequence of alignment specifiers, each of which can have the following values: left, center, or right.
        Returns:
        value of the columnalign attribute.

      • setColumnalign

        void setColumnalign​(java.lang.String columnalign)
        setter for the columnalign attribute.
        Parameters:
        columnalign - new value for columnalign.
        See Also:
        getColumnalign()

      • getGroupalign

        java.lang.String getGroupalign()
        A string specifying how the alignment groups within the cells of each row are to be aligned with the corresponding items above or below them in the same column. The string consists of a sequence of braced group alignment lists. Each group alignment list is a space-separated sequence, each of which can have the following values: left, right, center, or decimalpoint.
        Returns:
        value of the groupalign attribute.

      • setGroupalign

        void setGroupalign​(java.lang.String groupalign)
        setter for the groupalign attribute.
        Parameters:
        groupalign - new value for groupalign.
        See Also:
        getGroupalign()

      • getAlignmentscope

        java.lang.String getAlignmentscope()
        A string consisting of the values true or false indicating, for each column, whether it can be used as an alignment scope.
        Returns:
        value of the alignmentscope attribute.

      • setAlignmentscope

        void setAlignmentscope​(java.lang.String alignmentscope)
        setter for the alignmentscope attribute.
        Parameters:
        alignmentscope - new value for alignmentscope.
        See Also:
        getAlignmentscope()

      • getColumnwidth

        java.lang.String getColumnwidth()
        A string consisting of a space-separated sequence of specifiers, each of which can have one of the following forms: auto, number h-unit, namedspace, or fit. (A value of the form namedspace is one of veryverythinmathspace, verythinmathspace, thinmathspace, mediummathspace, thickmathspace, verythickmathspace, or veryverythickmathspace.) This represents the element's columnwidth attribute.
        Returns:
        value of the columnwidth attribute.

      • setColumnwidth

        void setColumnwidth​(java.lang.String columnwidth)
        setter for the columnwidth attribute.
        Parameters:
        columnwidth - new value for columnwidth.
        See Also:
        getColumnwidth()

      • getWidth

        java.lang.String getWidth()
        A string that is either of the form number h-unit or is the string auto. This represents the element's width attribute.
        Returns:
        value of the width attribute.

      • setWidth

        void setWidth​(java.lang.String width)
        setter for the width attribute.
        Parameters:
        width - new value for width.
        See Also:
        getWidth()

      • getRowspacing

        java.lang.String getRowspacing()
        A string consisting of a space-separated sequence of specifiers of the form number v-unit representing the space to be added between rows.
        Returns:
        value of the rowspacing attribute.

      • setRowspacing

        void setRowspacing​(java.lang.String rowspacing)
        setter for the rowspacing attribute.
        Parameters:
        rowspacing - new value for rowspacing.
        See Also:
        getRowspacing()

      • getColumnspacing

        java.lang.String getColumnspacing()
        A string consisting of a space-separated sequence of specifiers of the form number h-unit representing the space to be added between columns.
        Returns:
        value of the columnspacing attribute.

      • setColumnspacing

        void setColumnspacing​(java.lang.String columnspacing)
        setter for the columnspacing attribute.
        Parameters:
        columnspacing - new value for columnspacing.
        See Also:
        getColumnspacing()

      • getRowlines

        java.lang.String getRowlines()
        A string specifying whether and what kind of lines should be added between each row. The string consists of a space-separated sequence of specifiers, each of which can have the following values: none, solid, or dashed.
        Returns:
        value of the rowlines attribute.

      • setRowlines

        void setRowlines​(java.lang.String rowlines)
        setter for the rowlines attribute.
        Parameters:
        rowlines - new value for rowlines.
        See Also:
        getRowlines()

      • getColumnlines

        java.lang.String getColumnlines()
        A string specifying whether and what kind of lines should be added between each column. The string consists of a space-separated sequence of specifiers, each of which can have the following values: none, solid, or dashed.
        Returns:
        value of the columnlines attribute.

      • setColumnlines

        void setColumnlines​(java.lang.String columnlines)
        setter for the columnlines attribute.
        Parameters:
        columnlines - new value for columnlines.
        See Also:
        getColumnlines()

      • getFrame

        java.lang.String getFrame()
        A string specifying a frame around the table. Allowed values are (none | solid | dashed).
        Returns:
        value of the frame attribute.

      • setFrame

        void setFrame​(java.lang.String frame)
        setter for the frame attribute.
        Parameters:
        frame - new value for frame.
        See Also:
        getFrame()

      • getFramespacing

        java.lang.String getFramespacing()
        A string of the form number h-unit number v-unit specifying the spacing between table and its frame.
        Returns:
        value of the framespacing attribute.

      • setFramespacing

        void setFramespacing​(java.lang.String framespacing)
        setter for the framespacing attribute.
        Parameters:
        framespacing - new value for framespacing.
        See Also:
        getFramespacing()

      • getEqualrows

        java.lang.String getEqualrows()
        A string with the values true or false.
        Returns:
        value of the equalrows attribute.

      • setEqualrows

        void setEqualrows​(java.lang.String equalrows)
        setter for the equalrows attribute.
        Parameters:
        equalrows - new value for equalrows.
        See Also:
        getEqualrows()

      • getEqualcolumns

        java.lang.String getEqualcolumns()
        A string with the values true or false.
        Returns:
        value of the equalcolumns attribute.

      • setEqualcolumns

        void setEqualcolumns​(java.lang.String equalcolumns)
        setter for the equalcolumns attribute.
        Parameters:
        equalcolumns - new value for equalcolumns.
        See Also:
        getEqualcolumns()

      • getDisplaystyle

        java.lang.String getDisplaystyle()
        A string with the values true or false.
        Returns:
        value of the displaystyle attribute.

      • setDisplaystyle

        void setDisplaystyle​(java.lang.String displaystyle)
        setter for the displaystyle attribute.
        Parameters:
        displaystyle - new value for displaystyle.
        See Also:
        getDisplaystyle()

      • getSide

        java.lang.String getSide()
        A string with the values left, right, leftoverlap, or rightoverlap.
        Returns:
        value of the side attribute.

      • setSide

        void setSide​(java.lang.String side)
        setter for the side attribute.
        Parameters:
        side - new value for side.
        See Also:
        getSide()

      • getMinlabelspacing

        java.lang.String getMinlabelspacing()
        A string of the form number h-unit, specifying the minimum space between a label and the adjacent entry in the labeled row.
        Returns:
        value of the minlabelspacing attribute.

      • setMinlabelspacing

        void setMinlabelspacing​(java.lang.String minlabelspacing)
        setter for the minlabelspacing attribute.
        Parameters:
        minlabelspacing - new value for minlabelspacing.
        See Also:
        getMinlabelspacing()

      • getRows

        MathMLNodeList getRows()
        A MathMLNodeList consisting of MathMLTableRowElements and MathMLLabeledRowElements representing the rows of the table. This is a live object.
        Returns:
        value of the rows attribute.

      • insertEmptyRow

        MathMLTableRowElement insertEmptyRow​(long index)
                              throws org.w3c.dom.DOMException
        A convenience method to insert a new (empty) row (mtr) in the table before the current index-th row. If index is less than 0, the new row is inserted before the -index-th row counting up from the current last row; if index is equal to the current number of rows, the new row is appended as the last row.
        Parameters:
        index - Position before which to insert the new row, where 0 represents the first row. Negative numbers are used to count backwards from the last row.
        Returns:
        Returns the MathMLTableRowElement child of this MathMLTableElement that represents the new mtr element being inserted.
        Throws:
        org.w3c.dom.DOMException - INDEX_SIZE_ERR: Raised if index is greater than the current number of rows of this mtable element or less than minus this number.

      • insertEmptyLabeledRow

        MathMLLabeledRowElement insertEmptyLabeledRow​(long index)
                                       throws org.w3c.dom.DOMException
        A convenience method to insert a new (empty) labeled row (mlabeledtr) in the table before the current index-th row. If index is less than 0, the new row is inserted before the -index-th row counting up from the current last row; if index is equal to the current number of rows, the new row is appended as the last row.
        Parameters:
        index - Position before which to insert the new row, where 0 represents the first row. Negative numbers are used to count backwards from the last row.
        Returns:
        Returns the MathMLLabeledRowElement child of this MathMLTableElement representing the mtr element being inserted.
        Throws:
        org.w3c.dom.DOMException - INDEX_SIZE_ERR: Raised if index is greater than the current number of rows of this mtable element or less than minus this number.

      • getRow

        MathMLTableRowElement getRow​(long index)
        A convenience method to retrieve the index-th row from the table. If index is less than 0, the -index-th row from the bottom of the table is retrieved. (So, for instance, if index is -2, the next-to-last row is retrieved.) If index is not a valid value (i.e. is greater than or equal to the number of rows, or is less than minus the number of rows), a null MathMLTableRowElement is returned.
        Parameters:
        index - Index of the row to be returned, where 0 represents the first row. Negative numbers are used to count backwards from the last row.
        Returns:
        Returns the MathMLTableRowElement representing the index-th row of the table.

      • insertRow

        MathMLTableRowElement insertRow​(long index,
                                MathMLTableRowElement newRow)
                         throws org.w3c.dom.DOMException
        A convenience method to insert the new row or labeled row (mtr or mlabeledtr) represented by newRow in the table before the current index-th row. If index is equal to the current number of rows, newRow is appended as the last row in the table. If index is less than 0, the new row is inserted before the -index-th row from the bottom of the table. (So, for instance, if index is -2, the new row is inserted before the next-to-last current row.)
        Parameters:
        index - Index before which to insert newRow, where 0 represents the first row. Negative numbers are used to count backwards from the current last row.
        newRow - A MathMLTableRowElement or MathMLLabeledRowElement representing the row to be inserted.
        Returns:
        The MathMLTableRowElement or MathMLLabeledRowElement child of this MathMLTableElement representing the mtr element being inserted.
        Throws:
        org.w3c.dom.DOMException - HIERARCHY_REQUEST_ERR: Raised if newRow is not a MathMLTableRowElement or MathMLLabeledRowElement. INDEX_SIZE_ERR: Raised if index is greater than the current number of rows or less than minus the current number of rows of this mtable element.

      • setRow

        MathMLTableRowElement setRow​(long index,
                             MathMLTableRowElement newRow)
                      throws org.w3c.dom.DOMException
        A method to set the value of the row in the table at the specified index to the mtr or mlabeledtr represented by newRow. If index is less than 0, the -index-th row counting up from the last is replaced by newRow; if index is one more than the current number of rows, the new row is appended as the last row in the table.
        Parameters:
        index - Index of the row to be set to newRow, where 0 represents the first row. Negative numbers are used to count backwards from the last row.
        newRow - A MathMLTableRowElement representing the row that is to be the new index-th row.
        Returns:
        Returns the MathMLTableRowElement or MathMLLabeledRowElement child of this element that represents the new row in the DOM.
        Throws:
        org.w3c.dom.DOMException - HIERARCHY_REQUEST_ERR: Raised if newRow is not a MathMLTableRowElement or MathMLLabeledRowElement. INDEX_SIZE_ERR: Raised if index is greater than the current number of rows of this mtable element or less than minus this number.

      • deleteRow

        void deleteRow​(long index)
        throws org.w3c.dom.DOMException
        A convenience method to delete the row of the table at the specified index. If index is less than 0, the -index-th row from the bottom of the table is deleted. (So, for instance, if index is -2, the next-to-last row is deleted.)
        Parameters:
        index - Index of row to be deleted, where 0 represents the first row.
        Throws:
        org.w3c.dom.DOMException - INDEX_SIZE_ERR: Raised if index is greater than or equal to the current number of rows of this mtable element or less than minus this number.

      • removeRow

        MathMLTableRowElement removeRow​(long index)
                         throws org.w3c.dom.DOMException
        A convenience method to delete the row of the table at the specified index and return it to the caller. If index is less than 0, the -index-th row from the bottom of the table is deleted. (So, for instance, if index is -2, the next-to-last row is deleted.)
        Parameters:
        index - Index of row to be removed, where 0 represents the first row.
        Returns:
        A MathMLTableRowElement representing the row being deleted.
        Throws:
        org.w3c.dom.DOMException - INDEX_SIZE_ERR: Raised if index is greater than or equal to the number of rows of this mtable element or less than minus this number.