Interface MathMLMultiScriptsElement

All Superinterfaces:

Element, MathMLElement, MathMLPresentationElement, Node

public interface MathMLMultiScriptsElement
extends MathMLPresentationElement

This interface represents the mmultiscripts element, which is used to attach multiple subscripts and superscripts to a base element.

Since:

1.0

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Field Summary

Fields inherited from interface 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

Modifier and Type	Method	Description
MathMLElement	getBase()	Returns the base element to which scripts are attached.
int	getNumprescriptcolumns()	Returns the number of columns of prescripts.
int	getNumscriptcolumns()	Returns the number of columns of postscripts (scripts).
MathMLNodeList	getPrescripts()	Returns the list of prescripts attached to the base.
MathMLElement	getPreSubScript(int colIndex)	Retrieves the prescript subscript at the specified column index.
MathMLElement	getPreSuperScript(int colIndex)	Retrieves the prescript superscript at the specified column index.
MathMLNodeList	getScripts()	Returns the list of postscripts (scripts) attached to the base.
MathMLElement	getSubScript(int colIndex)	Retrieves the postscript subscript at the specified column index.
String	getSubscriptshift()	Returns the shift amount for subscripts.
MathMLElement	getSuperScript(int colIndex)	Retrieves the postscript superscript at the specified column index.
String	getSuperscriptshift()	Returns the shift amount for superscripts.
MathMLElement	insertPreSubScriptBefore(int colIndex, MathMLElement newScript)	Inserts a new prescript subscript before the specified column.
MathMLElement	insertPreSuperScriptBefore(int colIndex, MathMLElement newScript)	Inserts a new prescript superscript before the specified column.
MathMLElement	insertSubScriptBefore(int colIndex, MathMLElement newScript)	Inserts a new postscript subscript before the specified column.
MathMLElement	insertSuperScriptBefore(int colIndex, MathMLElement newScript)	Inserts a new postscript superscript before the specified column.
void	setBase(MathMLElement base)	Sets the base element to which scripts are attached.
MathMLElement	setPreSubScriptAt(int colIndex, MathMLElement newScript)	Sets the prescript subscript at the specified column.
MathMLElement	setPreSuperScriptAt(int colIndex, MathMLElement newScript)	Sets the prescript superscript at the specified column.
MathMLElement	setSubScriptAt(int colIndex, MathMLElement newScript)	Sets the postscript subscript at the specified column.
void	setSubscriptshift(String subscriptshift)	Sets the shift amount for subscripts.
MathMLElement	setSuperScriptAt(int colIndex, MathMLElement newScript)	Sets the postscript superscript at the specified column.
void	setSuperscriptshift(String superscriptshift)	Sets the shift amount for superscripts.

Methods inherited from interface 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 MathMLElement

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

Methods inherited from interface 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 Details

getSubscriptshift

String getSubscriptshift()

Returns the shift amount for subscripts.

Returns:

the subscriptshift attribute value.

setSubscriptshift

void setSubscriptshift(String subscriptshift)

Sets the shift amount for subscripts.

Parameters:

subscriptshift - the shift amount string.

getSuperscriptshift

String getSuperscriptshift()

Returns the shift amount for superscripts.

Returns:

the superscriptshift attribute value.

setSuperscriptshift

void setSuperscriptshift(String superscriptshift)

Sets the shift amount for superscripts.

Parameters:

superscriptshift - the shift amount string.

getBase

MathMLElement getBase()

Returns the base element to which scripts are attached.

Returns:

the base MathMLElement.

setBase

void setBase(MathMLElement base)

Sets the base element to which scripts are attached.

Parameters:

base - the base MathMLElement to set.

getPrescripts

MathMLNodeList getPrescripts()

Returns the list of prescripts attached to the base.

Returns:

a MathMLNodeList of prescripts.

getScripts

MathMLNodeList getScripts()

Returns the list of postscripts (scripts) attached to the base.

Returns:

a MathMLNodeList of postscripts.

getNumprescriptcolumns

int getNumprescriptcolumns()

Returns the number of columns of prescripts.

Returns:

the number of prescript columns.

getNumscriptcolumns

int getNumscriptcolumns()

Returns the number of columns of postscripts (scripts).

Returns:

the number of script columns.

getPreSubScript

MathMLElement getPreSubScript(int colIndex)

Retrieves the prescript subscript at the specified column index.

Parameters:

colIndex - the column index (1-based).

Returns:

the requested prescript subscript.

getSubScript

MathMLElement getSubScript(int colIndex)

Retrieves the postscript subscript at the specified column index.

Parameters:

colIndex - the column index (1-based).

Returns:

the requested postscript subscript.

getPreSuperScript

MathMLElement getPreSuperScript(int colIndex)

Retrieves the prescript superscript at the specified column index.

Parameters:

colIndex - the column index (1-based).

Returns:

the requested prescript superscript.

getSuperScript

MathMLElement getSuperScript(int colIndex)

Retrieves the postscript superscript at the specified column index.

Parameters:

colIndex - the column index (1-based).

Returns:

the requested postscript superscript.

insertPreSubScriptBefore

MathMLElement insertPreSubScriptBefore(int colIndex,
 MathMLElement newScript)
                                throws DOMException

Inserts a new prescript subscript before the specified column.

Parameters:

colIndex - the column index before which to insert.

newScript - the new subscript element.

Returns:

the newly inserted element.

Throws:

DOMException - INDEX_SIZE_ERR: if the column index is out of range.

setPreSubScriptAt

MathMLElement setPreSubScriptAt(int colIndex,
 MathMLElement newScript)
                         throws DOMException

Sets the prescript subscript at the specified column.

Parameters:

colIndex - the column index.

newScript - the replacement subscript element.

Returns:

the newly set element.

Throws:

DOMException - INDEX_SIZE_ERR: if the column index is out of range.

insertSubScriptBefore

MathMLElement insertSubScriptBefore(int colIndex,
 MathMLElement newScript)
                             throws DOMException

Inserts a new postscript subscript before the specified column.

Parameters:

colIndex - the column index before which to insert.

newScript - the new subscript element.

Returns:

the newly inserted element.

Throws:

DOMException - INDEX_SIZE_ERR: if the column index is out of range.

setSubScriptAt

MathMLElement setSubScriptAt(int colIndex,
 MathMLElement newScript)
                      throws DOMException

Sets the postscript subscript at the specified column.

Parameters:

colIndex - the column index.

newScript - the replacement subscript element.

Returns:

the newly set element.

Throws:

DOMException - INDEX_SIZE_ERR: if the column index is out of range.

insertPreSuperScriptBefore

MathMLElement insertPreSuperScriptBefore(int colIndex,
 MathMLElement newScript)
                                  throws DOMException

Inserts a new prescript superscript before the specified column.

Parameters:

colIndex - the column index before which to insert.

newScript - the new superscript element.

Returns:

the newly inserted element.

Throws:

DOMException - INDEX_SIZE_ERR: if the column index is out of range.

setPreSuperScriptAt

MathMLElement setPreSuperScriptAt(int colIndex,
 MathMLElement newScript)
                           throws DOMException

Sets the prescript superscript at the specified column.

Parameters:

colIndex - the column index.

newScript - the replacement superscript element.

Returns:

the newly set element.

Throws:

DOMException - INDEX_SIZE_ERR: if the column index is out of range.

insertSuperScriptBefore

MathMLElement insertSuperScriptBefore(int colIndex,
 MathMLElement newScript)
                               throws DOMException

Inserts a new postscript superscript before the specified column.

Parameters:

colIndex - the column index before which to insert.

newScript - the new superscript element.

Returns:

the newly inserted element.

Throws:

DOMException - INDEX_SIZE_ERR: if the column index is out of range.

setSuperScriptAt

MathMLElement setSuperScriptAt(int colIndex,
 MathMLElement newScript)
                        throws DOMException

Sets the postscript superscript at the specified column.

Parameters:

colIndex - the column index.

newScript - the replacement superscript element.

Returns:

the newly set element.

Throws:

DOMException - INDEX_SIZE_ERR: if the column index is out of range.