com.aspose.words

Class OfficeMath

java.lang.Object

com.aspose.words.Node

com.aspose.words.CompositeNode

com.aspose.words.OfficeMath

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

public class OfficeMath
extends CompositeNode

Represents an Office Math object such as function, equation, matrix or alike. Can contain child elements including runs of mathematical text, bookmarks, comments, other OfficeMath instances and some other nodes.

In this version of Aspose.Words, OfficeMath nodes do not provide public methods and properties to create or modify a OfficeMath object. In this version you are not able to instantiate N:Aspose.Words.Math nodes or modify existing except deleting them.

OfficeMath can only be a child of Paragraph.

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
void	clearRunAttrs()
java.lang.Object	fetchInheritedRunAttr(int fontAttr)
java.lang.Object	getDirectRunAttr(int fontAttr)
int	getDisplayType() Gets/sets Office Math display format type which represents whether an equation is displayed inline with the text or displayed on its own line.
DocumentBase	getDocument_IInline()
java.nio.charset.Charset	getEquationXmlEncoding() Gets/sets an encoding that was used to encode equation XML, if this office math object is read from equation XML.
int	getJustification() Gets/sets Office Math justification.
int	getMathObjectType() Gets type getMathObjectType() of this Office Math object.
OfficeMathRenderer	getMathRenderer() Creates and returns an object that can be used to render this equation into an image.
int	getNodeType() Returns NodeType.OfficeMath.
Paragraph	getParentParagraph_IInline()
Paragraph	getParentParagraph() Retrieves the parent Paragraph of this node.
void	removeMoveRevisions()
void	removeRunAttr(int key)
void	setDisplayType(int value) Gets/sets Office Math display format type which represents whether an equation is displayed inline with the text or displayed on its own line.
void	setEquationXmlEncoding(java.nio.charset.Charset value) Gets/sets an encoding that was used to encode equation XML, if this office math object is read from equation XML.
void	setJustification(int value) Gets/sets Office Math justification.
void	setRunAttr(int fontAttr, java.lang.Object value)

Methods inherited from class com.aspose.words.CompositeNode

acceptChildren, acceptCore, appendChild, coreRemoveSelfOnly, getChild, getChildNodes, getChildNodes, getContainer, getCount, getCurrentNode, getFirstChild, getLastChild, getNextMatchingNode, getText, hasChildNodes, indexOf, insertAfter, insertBefore, isComposite, iterator, prependChild, removeAllChildren, removeChild, removeSmartTags, selectNodes, selectSingleNode

Methods inherited from class com.aspose.words.Node

dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getParentNode, getPreviousSibling, getRange, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, toString, visitorActionToBool

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

accept

public boolean accept(DocumentVisitor visitor)
               throws java.lang.Exception

Accepts a visitor.

Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.

For more info see the Visitor design pattern.

Specified by:

accept in class Node

Parameters:

visitor - The visitor that will visit the nodes.

Returns:

True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

Throws:

java.lang.Exception

getMathRenderer

public OfficeMathRenderer getMathRenderer()
                                   throws java.lang.Exception

Creates and returns an object that can be used to render this equation into an image.

This method just invokes the OfficeMathRenderer constructor and passes this object as a parameter.

Returns:

The renderer object for this equation.

Throws:

java.lang.Exception

getDirectRunAttr

public java.lang.Object getDirectRunAttr(int fontAttr)

fetchInheritedRunAttr

public java.lang.Object fetchInheritedRunAttr(int fontAttr)

setRunAttr

public void setRunAttr(int fontAttr,
                       java.lang.Object value)

removeRunAttr

public void removeRunAttr(int key)

clearRunAttrs

public void clearRunAttrs()

getNodeType

public int getNodeType()

Returns NodeType.OfficeMath.

Specified by:

getNodeType in class Node

Returns:

NodeType.OfficeMath. The returned value is one of NodeType constants.

getParentParagraph

public Paragraph getParentParagraph()

Retrieves the parent Paragraph of this node.

Returns:

The corresponding Paragraph value.

getParentParagraph_IInline

public Paragraph getParentParagraph_IInline()

getDocument_IInline

public DocumentBase getDocument_IInline()

getMathObjectType

public int getMathObjectType()

Gets type getMathObjectType() of this Office Math object.

Returns:

Type getMathObjectType() of this Office Math object. The returned value is one of MathObjectType constants.

getEquationXmlEncoding

public java.nio.charset.Charset getEquationXmlEncoding()

Gets/sets an encoding that was used to encode equation XML, if this office math object is read from equation XML. We use the encoding on saving a document to write in same encoding that it was read.

Returns:

The corresponding Charset value.

setEquationXmlEncoding

public void setEquationXmlEncoding(java.nio.charset.Charset value)

Gets/sets an encoding that was used to encode equation XML, if this office math object is read from equation XML. We use the encoding on saving a document to write in same encoding that it was read.

Parameters:

value - The corresponding Charset value.

getJustification

public int getJustification()

Gets/sets Office Math justification.

Justification cannot be set to the Office Math with display format type OfficeMathDisplayType.INLINE.

Inline justification cannot be set to the Office Math with display format type OfficeMathDisplayType.DISPLAY.

Corresponding getDisplayType() / setDisplayType(int) has to be set before setting Office Math justification.

Returns:

The corresponding int value. The returned value is one of OfficeMathJustification constants.

setJustification

public void setJustification(int value)

Gets/sets Office Math justification.

Justification cannot be set to the Office Math with display format type OfficeMathDisplayType.INLINE.

Inline justification cannot be set to the Office Math with display format type OfficeMathDisplayType.DISPLAY.

Corresponding getDisplayType() / setDisplayType(int) has to be set before setting Office Math justification.

Parameters:

value - The corresponding int value. The value must be one of OfficeMathJustification constants.

getDisplayType

public int getDisplayType()

Gets/sets Office Math display format type which represents whether an equation is displayed inline with the text or displayed on its own line.

Display format type has effect for top level Office Math only.

Returned display format type is always OfficeMathDisplayType.INLINE for nested Office Math.

Returns:

The corresponding int value. The returned value is one of OfficeMathDisplayType constants.

setDisplayType

public void setDisplayType(int value)

Gets/sets Office Math display format type which represents whether an equation is displayed inline with the text or displayed on its own line.

Display format type has effect for top level Office Math only.

Returned display format type is always OfficeMathDisplayType.INLINE for nested Office Math.

Parameters:

value - The corresponding int value. The value must be one of OfficeMathDisplayType constants.

removeMoveRevisions

public void removeMoveRevisions()