NaryEquationNode

Inheritance: java.lang.Object, com.aspose.cells.FontSetting, com.aspose.cells.EquationNode

public class NaryEquationNode extends EquationNode

This class specifies an n-ary operator equation consisting of an n-ary operator, a base (or operand), and optional upper and lower bounds.

Methods

Method	Description
addChild(EquationNode node)	Inserts the specified node at the end of the current node’s list of child nodes.
addChild(int equationType)	Insert a node of the specified type at the end of the child node list of the current node.
createNode(int equationType, Workbook workbook, EquationNode parent)	Create a node of the specified type.
equals(Object obj)	Determine whether the current equation node is equal to the specified node
getChild(int index)	Returns the node at the specified index among the children of the current node.
getClass()
getEquationType()	Get the equation type of the current node
getFont()	Returns the font of this object.
getLength()	Gets the length of the characters.
getLimitLocation()	This attribute specifies the location of limits in n-ary operators.
getNaryGrow()	This attribute specifies the growth property of n-ary operators at the document level.
getNaryOperator()	an n-ary operator.e.g “\u922d?.
getNaryOperatorType()	an n-ary operator.e.g “\u922d?
getParentNode()	Specifies the parent node of the current node
getStartIndex()	Gets the start index of the characters.
getTextOptions()	Returns the text options.
getType()	Represents the type of the node.
hashCode()
insertAfter(int equationType)	Inserts the specified node after the current node.
insertBefore(int equationType)	Inserts the specified node before the current node.
insertChild(int index, int equationType)	Inserts a node of the specified type at the specified index position in the current node’s child node list.
isHideSubscript()	Whether to display the lower bound
isHideSuperscript()	Whether to display the upper bound
notify()
notifyAll()
remove()	Removes itself from the parent.
removeAllChildren()	Removes all the child nodes of the current node.
removeChild(EquationNode node)	Removes the specified node from the current node’s children.
removeChild(int index)	Removes the node at the specified index from the current node’s children.
setHideSubscript(boolean value)	Whether to display the lower bound
setHideSuperscript(boolean value)	Whether to display the upper bound
setLimitLocation(int value)	This attribute specifies the location of limits in n-ary operators.
setNaryGrow(boolean value)	This attribute specifies the growth property of n-ary operators at the document level.
setNaryOperator(String value)	an n-ary operator.e.g “\u922d?.
setNaryOperatorType(int value)	an n-ary operator.e.g “\u922d?
setParentNode(EquationNode value)	Specifies the parent node of the current node
setWordArtStyle(int style)	Sets the preset WordArt style.
toLaTeX()	Convert this equtation to LaTeX expression.
toMathML()	Convert this equtation to MathML expression.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

addChild(EquationNode node)

public void addChild(EquationNode node)

Inserts the specified node at the end of the current node’s list of child nodes.

Parameters:

Parameter	Type	Description
node	EquationNode	The specified node

addChild(int equationType)

public EquationNode addChild(int equationType)

Insert a node of the specified type at the end of the child node list of the current node.

Parameters:

Parameter	Type	Description
equationType	int	EquationNodeType. Types of Equation Nodes

Returns: EquationNode - If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.

createNode(int equationType, Workbook workbook, EquationNode parent)

public static EquationNode createNode(int equationType, Workbook workbook, EquationNode parent)

Create a node of the specified type.

Parameters:

Parameter	Type	Description
equationType	int	EquationNodeType. Types of Equation Nodes
workbook	Workbook	The workbook object associated with the equation
parent	EquationNode	The parent node where this node is located

Returns: EquationNode - If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.

equals(Object obj)

public boolean equals(Object obj)

Determine whether the current equation node is equal to the specified node

Parameters:

Parameter	Type	Description
obj	java.lang.Object	The specified node

Returns: boolean -

getChild(int index)

public EquationNode getChild(int index)

Returns the node at the specified index among the children of the current node.

Parameters:

Parameter	Type	Description
index	int	Index of the node

Returns: EquationNode - Returns the corresponding node if the specified node exists, otherwise returns null.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getEquationType()

public int getEquationType()

Get the equation type of the current node

See EquationNodeType.

Returns: int

getFont()

public Font getFont()

Returns the font of this object.

Returns: Font

getLength()

public int getLength()

Gets the length of the characters.

Returns: int

getLimitLocation()

public int getLimitLocation()

This attribute specifies the location of limits in n-ary operators. Limits can be either centered above and below the n-ary operator, or positioned just to the right of the operator.

See EquationLimitLocationType.

Returns: int

getNaryGrow()

public boolean getNaryGrow()

This attribute specifies the growth property of n-ary operators at the document level. When off, n-ary operators such as integrals and summations do not grow to match the size of their operand height. When on, the n-ary operator grows vertically to match its operand height.

Returns: boolean

getNaryOperator()

public String getNaryOperator()

an n-ary operator.e.g “\u922d?. It is strongly recommended to use attribute NaryOperatorType to set n-ary operator. Use this property setting if you cannot find the character you need in a known type.

Remarks

It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted.

Returns: java.lang.String

getNaryOperatorType()

public int getNaryOperatorType()

an n-ary operator.e.g “\u922d?

See EquationMathematicalOperatorType.

Returns: int

getParentNode()

public EquationNode getParentNode()

Specifies the parent node of the current node

Returns: EquationNode

getStartIndex()

public int getStartIndex()

Gets the start index of the characters.

Returns: int

getTextOptions()

public TextOptions getTextOptions()

Returns the text options.

Returns: TextOptions

getType()

public int getType()

Represents the type of the node.

See TextNodeType.

Returns: int

hashCode()

public native int hashCode()

Returns: int

insertAfter(int equationType)

public EquationNode insertAfter(int equationType)

Inserts the specified node after the current node.

Parameters:

Parameter	Type	Description
equationType	int	EquationNodeType. Types of Equation Nodes

Returns: EquationNode - If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.

insertBefore(int equationType)

public EquationNode insertBefore(int equationType)

Inserts the specified node before the current node.

Parameters:

Parameter	Type	Description
equationType	int	EquationNodeType. Types of Equation Nodes

Returns: EquationNode - If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.

insertChild(int index, int equationType)

public EquationNode insertChild(int index, int equationType)

Inserts a node of the specified type at the specified index position in the current node’s child node list.

Parameters:

Parameter	Type	Description
index	int	index value
equationType	int	EquationNodeType. Types of Equation Nodes

Returns: EquationNode - If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.

isHideSubscript()

public boolean isHideSubscript()

Whether to display the lower bound

Returns: boolean

isHideSuperscript()

public boolean isHideSuperscript()

Whether to display the upper bound

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

remove()

public void remove()

Removes itself from the parent.

removeAllChildren()

public void removeAllChildren()

Removes all the child nodes of the current node.

removeChild(EquationNode node)

public void removeChild(EquationNode node)

Removes the specified node from the current node’s children.

Parameters:

Parameter	Type	Description
node	EquationNode	Node to be deleted.

removeChild(int index)

public void removeChild(int index)

Removes the node at the specified index from the current node’s children.

Parameters:

Parameter	Type	Description
index	int	Index of the node

setHideSubscript(boolean value)

public void setHideSubscript(boolean value)

Whether to display the lower bound

Parameters:

Parameter	Type	Description
value	boolean

setHideSuperscript(boolean value)

public void setHideSuperscript(boolean value)

Whether to display the upper bound

Parameters:

Parameter	Type	Description
value	boolean

setLimitLocation(int value)

public void setLimitLocation(int value)

This attribute specifies the location of limits in n-ary operators. Limits can be either centered above and below the n-ary operator, or positioned just to the right of the operator.

See EquationLimitLocationType.

Parameters:

Parameter	Type	Description
value	int

setNaryGrow(boolean value)

public void setNaryGrow(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

setNaryOperator(String value)

public void setNaryOperator(String value)

Remarks

It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted.

Parameters:

Parameter	Type	Description
value	java.lang.String

setNaryOperatorType(int value)

public void setNaryOperatorType(int value)

an n-ary operator.e.g “\u922d?

See EquationMathematicalOperatorType.

Parameters:

Parameter	Type	Description
value	int

setParentNode(EquationNode value)

public void setParentNode(EquationNode value)

Specifies the parent node of the current node

Parameters:

Parameter	Type	Description
value	EquationNode

setWordArtStyle(int style)

public void setWordArtStyle(int style)

Sets the preset WordArt style.

Remarks

Only for the text of shape/chart.

Parameters:

Parameter	Type	Description
style	int	PresetWordArtStyle. The preset WordArt style.

toLaTeX()

public String toLaTeX()

Convert this equtation to LaTeX expression.

Returns: java.lang.String

toMathML()

public String toMathML()

Convert this equtation to MathML expression.

Returns: java.lang.String -

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int