org.w3c.dom.mathml
Interface MathMLMatrixrowElement

All Superinterfaces:

Element, MathMLContentElement, MathMLElement, Node

public interface MathMLMatrixrowElement
extends MathMLContentElement

The matrixrow element is the container element for the elements of a matrix.

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

void	deleteEntry(int index) A convenience method to delete an entry.
MathMLContentElement	getEntry(int index) A convenience method to retrieve the contents of an entry by index.
int	getNEntries() The number of entries in the row.
MathMLContentElement	insertEntry(MathMLContentElement newEntry, int index) A convenience method to insert an entry before the current index-th entry of the row.
MathMLContentElement	removeEntry(int index) A convenience method to remove an entry from the row and return the removed entry to the caller.
MathMLContentElement	setEntry(MathMLContentElement newEntry, int index) A convenience method to set the contents of the entry at position index in the row to newEntry.

Methods inherited from interface org.w3c.dom.mathml.MathMLElement

getClassName, getHref, getId, getMathElementStyle, getOwnerMathElement, getXref, setClassName, setHref, setId, setMathElementStyle, setXref

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

getNEntries

int getNEntries()

The number of entries in the row.

Returns:

value of the nEntries attribute.

getEntry

MathMLContentElement getEntry(int index)
                              throws DOMException

A convenience method to retrieve the contents of an entry by index.

Parameters:

index - Position of the entry in the row. The first entry is numbered 1.

Returns:

The MathMLContentElement element representing the index-th entry in the row.

Throws:

DOMException - INDEX_SIZE_ERR: Raised if index is greater than the number of entries in the row.

insertEntry

MathMLContentElement insertEntry(MathMLContentElement newEntry,
                                 int index)
                                 throws DOMException

A convenience method to insert an entry before the current index-th entry of the row. If index is 0, newEntry is appended as the last entry. Note that this method increases the size of the matrixrow.

Parameters:

newEntry - The MathMLContentElement to be representing the new entry to be inserted into the row.

index - The index before which newEntry is to be inserted in the row. The first entry is numbered 1.

Returns:

The MathMLContentElement child of this MathMLMatrixrowElement representing newEntry in the DOM.

Throws:

DOMException - INDEX_SIZE_ERR: Raised if index is greater than the number of entries in the row.

setEntry

MathMLContentElement setEntry(MathMLContentElement newEntry,
                              int index)
                              throws DOMException

A convenience method to set the contents of the entry at position index in the row to newEntry. If there is already a entry at the specified index, it is replaced by the new entry.

Parameters:

newEntry - The MathMLContentElement representing the element that is to be the index-th entry.

index - The index of the entry that is to be set equal to newEntry. The first entry is numbered 1.

Returns:

The MathMLContentElement child of this MathMLMatrixRowElement representing newEntry in the DOM.

Throws:

DOMException - INDEX_SIZE_ERR: Raised if index is greater than one more than the number of elements in the row.

deleteEntry

void deleteEntry(int index)
                 throws DOMException

A convenience method to delete an entry. The deletion changes the indices of the following entries.

Parameters:

index - Position of the entry to be deleted in the row. The first entry is numbered 1.

Throws:

DOMException - INDEX_SIZE_ERR: Raised if index is greater than the number of entries in the row.

removeEntry

MathMLContentElement removeEntry(int index)
                                 throws DOMException

A convenience method to remove an entry from the row and return the removed entry to the caller.

Parameters:

index - Position of the entry to be removed from the row. The first entry is numbered 1.

Returns:

The MathMLContentElement being removed from the row.

Throws:

DOMException - INDEX_SIZE_ERR: Raised if index is greater than the number of entries in the row.