net.sourceforge.jeuclid.content.semantic
Class Semantics

java.lang.Object
  net.sourceforge.jeuclid.dom.AbstractPartialNodeImpl
      net.sourceforge.jeuclid.dom.AbstractPartialElementImpl
          net.sourceforge.jeuclid.dom.AbstractChangeTrackingElement
              net.sourceforge.jeuclid.elements.AbstractJEuclidElement
                  net.sourceforge.jeuclid.elements.presentation.AbstractContainer
                      net.sourceforge.jeuclid.elements.presentation.general.AbstractMathElementWithChildren
                          net.sourceforge.jeuclid.elements.presentation.general.AbstractRowLike
                              net.sourceforge.jeuclid.content.semantic.Semantics

All Implemented Interfaces:

ChangeTrackingInterface, DisplayableNode, JEuclidElement, JEuclidNode, Element, MathMLContainer, MathMLElement, MathMLPresentationContainer, MathMLPresentationElement, MathMLSemanticsElement, Node

public class Semantics
extends AbstractRowLike
implements MathMLSemanticsElement

This class represents a semantics element.

Version:

$Revision: 310 $

Author:

Max Berger

Nested Class Summary

Nested classes/interfaces inherited from class net.sourceforge.jeuclid.dom.AbstractPartialElementImpl

AbstractPartialElementImpl.AttributeNodeMap, AbstractPartialElementImpl.AttrImpl

Nested classes/interfaces inherited from class net.sourceforge.jeuclid.dom.AbstractPartialNodeImpl

AbstractPartialNodeImpl.NodeList

Field Summary

static String

ELEMENT The XML element from this class.

Fields inherited from class net.sourceforge.jeuclid.elements.AbstractJEuclidElement

ALIGN_AXIS, ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_TOP, ATTR_CLASS, ATTR_DEPRECATED_BACKGROUND, ATTR_DEPRECATED_COLOR, ATTR_DEPRECATED_FONTFAMILY, ATTR_DEPRECATED_FONTSIZE, ATTR_DEPRECATED_FONTSTYLE, ATTR_DEPRECATED_FONTWEIGHT, ATTR_HREF, ATTR_ID, ATTR_MATHBACKGROUND, ATTR_MATHCOLOR, ATTR_MATHSIZE, ATTR_MATHVARIANT, ATTR_STYLE, ATTR_XREF, TRIVIAL_SPACE_MAX, URI

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

Constructor Summary

Semantics(MathBase base)
Creates a math element.

Method Summary

void	deleteAnnotation(int index) A convenience method to delete the index-th alternate content associated with this semantics element.
MathMLElement	getAnnotation(int index) This method gives access to the index-th alternate content associated with a semantics element.
MathMLElement	getBody() This attribute represents the first child of the semantics element, i.e. the child giving the primary content represented by the element.
int	getNAnnotations() Represents the number of annotation or annotation-xml children of the semantics element, i.e. the number of alternate content forms for this element.
String	getTagName()
MathMLElement	insertAnnotation(MathMLElement newAnnotation, int index) This method inserts newAnnotation before the current index-th alternate content associated with a semantics element.
MathMLElement	removeAnnotation(int index) A convenience method to delete the index-th alternate content associated with this semantics element, and to return it to the caller.
MathMLElement	setAnnotation(MathMLElement newAnnotation, int index) This method allows setting or replacement of the index-th alternate content associated with a semantics element.
void	setBody(MathMLElement body) setter for the body attribute.

Methods inherited from class net.sourceforge.jeuclid.elements.presentation.general.AbstractRowLike

calculateAscentHeight, calculateDescentHeight, calculateWidth, paint

Methods inherited from class net.sourceforge.jeuclid.elements.presentation.general.AbstractMathElementWithChildren

calculateChildrenAscentHeight, calculateChildrenDescentHeight, calculateChildrenWidth, paintChildren

Methods inherited from class net.sourceforge.jeuclid.elements.presentation.AbstractContainer

deleteArgument, deleteDeclaration, getArgument, getArguments, getDeclaration, getDeclarations, getNArguments, insertArgument, insertDeclaration, removeArgument, removeDeclaration, setArgument, setDeclaration

Methods inherited from class net.sourceforge.jeuclid.elements.AbstractJEuclidElement

addMathElement, addText, calculateHeight, changeHook, debug, getAbsoluteScriptLevel, getAscentHeight, getBackgroundColor, getClassName, getContents, getDescentHeight, getFont, getFontMetrics, getFontsizeInPoint, getForegroundColor, getGlobalLineCorrector, getHeight, getHref, getId, getIndexOfMathElement, getInheritedScriptlevel, getMathAttribute, getMathbackground, getMathBase, getMathcolor, getMathElement, getMathElementCount, getMathElementStyle, getMathsize, getMathsizeInPoint, getMathvariant, getMathvariantAsVariant, getMiddleShift, getOwnerMathElement, getPaintedPosX, getPaintedPosY, getParent, getScriptlevelForChild, getScriptSizeMultiplier, getText, getWidth, getXCenter, getXref, hasChildPostscripts, hasChildPrescripts, isCalculatingSize, isChildBlock, recalculateSize, setCalculatingSize, setClassName, setDefaultMathAttribute, setFakeParent, setGlobalLineCorrector, setHref, setId, setMathAttributes, setMathbackground, setMathBase, setMathcolor, setMathElement, setMathElementStyle, setMathsize, setMathvariant, setScriptSizeMultiplier, setXref

Methods inherited from class net.sourceforge.jeuclid.dom.AbstractChangeTrackingElement

addListener, appendChild, fireChanged, fireChangeForSubTree, replaceChild, setAttribute, setTextContent

Methods inherited from class net.sourceforge.jeuclid.dom.AbstractPartialElementImpl

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getElementsByTagName, getElementsByTagNameNS, getLocalName, getNodeName, getNodeType, getSchemaTypeInfo, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, toString

Methods inherited from class net.sourceforge.jeuclid.dom.AbstractPartialNodeImpl

cloneNode, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, setNodeValue, setPrefix, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, 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

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

deleteArgument, deleteDeclaration, getArgument, getArguments, getDeclaration, getDeclarations, getNArguments, insertArgument, insertDeclaration, removeArgument, removeDeclaration, setArgument, setDeclaration

Methods inherited from interface net.sourceforge.jeuclid.dom.ChangeTrackingInterface

addListener, fireChanged, fireChangeForSubTree

Field Detail

ELEMENT

public static final String ELEMENT

The XML element from this class.

See Also:

Constant Field Values

Constructor Detail

Semantics

public Semantics(MathBase base)

Creates a math element.

Parameters:

base - The base for the math element tree.

Method Detail

getTagName

public String getTagName()

Specified by:

getTagName in interface Element

deleteAnnotation

public void deleteAnnotation(int index)

A convenience method to delete the index-th alternate content associated with this semantics element.

Specified by:

deleteAnnotation in interface MathMLSemanticsElement

Parameters:

index - The one-based index of the annotation being deleted.

getAnnotation

public MathMLElement getAnnotation(int index)

This method gives access to the index-th alternate content associated with a semantics element.

Specified by:

getAnnotation in interface MathMLSemanticsElement

Parameters:

index - The one-based index of the annotation being retrieved.

Returns:

The MathMLAnnotationElement or MathMLXMLAnnotationElement representing the index-th annotation or annotation-xml child of the semantics element. Note that all child elements of a semantics element other than the first are required to be of one of these types.

getBody

public MathMLElement getBody()

This attribute represents the first child of the semantics element, i.e. the child giving the primary content represented by the element.

Specified by:

getBody in interface MathMLSemanticsElement

Returns:

value of the body attribute.

getNAnnotations

public int getNAnnotations()

Represents the number of annotation or annotation-xml children of the semantics element, i.e. the number of alternate content forms for this element.

Specified by:

getNAnnotations in interface MathMLSemanticsElement

Returns:

value of the nAnnotations attribute.

insertAnnotation

public MathMLElement insertAnnotation(MathMLElement newAnnotation,
                                      int index)

This method inserts newAnnotation before the current index-th alternate content associated with a semantics element. If index is 0, newAnnotation is appended as the last annotation or annotation-xml child of this element.

Specified by:

insertAnnotation in interface MathMLSemanticsElement

Parameters:

newAnnotation - A MathMLAnnotationElement or MathMLXMLAnnotationElement representing the new annotation or annotation-xml to be inserted.

index - The position in the list of annotation or annotation-xml children before which newAnnotation is to be inserted. The first annotation is numbered 1.

Returns:

The MathMLAnnotationElement or MathMLXMLAnnotationElement child of this element that represents the new annotation in the DOM.

removeAnnotation

public MathMLElement removeAnnotation(int index)

A convenience method to delete the index-th alternate content associated with this semantics element, and to return it to the caller.

Specified by:

removeAnnotation in interface MathMLSemanticsElement

Parameters:

index - The one-based index of the annotation being deleted.

Returns:

The MathMLAnnotationElement or MathMLXMLAnnotationElement being deleted.

setAnnotation

public MathMLElement setAnnotation(MathMLElement newAnnotation,
                                   int index)

This method allows setting or replacement of the index-th alternate content associated with a semantics element. If there is already an annotation or annotation-xml element with this index, it is replaced by newAnnotation.

Specified by:

setAnnotation in interface MathMLSemanticsElement

Parameters:

newAnnotation - A MathMLAnnotationElement or MathMLXMLAnnotationElement representing the new value of the index-th annotation or annotation-xml child of this semantics element.

index - The position in the list of annotation or annotation-xml children of this semantics element that is to be occupied by newAnnotation. The first annotation element is numbered 1.

Returns:

The MathMLAnnotationElement or MathMLXMLAnnotationElement child of this element that represents the new annotation in the DOM.

setBody

public void setBody(MathMLElement body)

setter for the body attribute.

Specified by:

setBody in interface MathMLSemanticsElement

Parameters:

body - new value for body.

See Also:

MathMLSemanticsElement.getBody()