GroupCharacterEquationNode

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

public class GroupCharacterEquationNode extends EquationNode

This class specifies the Group-Character function, consisting of a character drawn above or below text, often with the purpose of visually grouping items.

Methods

MethodDescription
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.
getChrType()Specify combining characters by type value.
getClass()
getEquationType()Get the equation type of the current node
getFont()Returns the font of this object.
getGroupChr()Specifies a symbol(default U+23DF).
getLength()Gets the length of the characters.
getParentNode()Specifies the parent node of the current node
getPosition()This attribute specifies the position of the character in the object
getStartIndex()Gets the start index of the characters.
getTextOptions()Returns the text options.
getType()Represents the type of the node.
getVertJc()This attribute, combined with pos of groupChrPr, specifies the vertical layout of the groupChr object.
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.
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.
setChrType(int value)Specify combining characters by type value.
setGroupChr(String value)Specifies a symbol(default U+23DF).
setParentNode(EquationNode value)Specifies the parent node of the current node
setPosition(int value)This attribute specifies the position of the character in the object
setVertJc(int value)This attribute, combined with pos of groupChrPr, specifies the vertical layout of the groupChr object.
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:

ParameterTypeDescription
nodeEquationNodeThe 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:

ParameterTypeDescription
equationTypeintEquationNodeType. 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:

ParameterTypeDescription
equationTypeintEquationNodeType. Types of Equation Nodes
workbookWorkbookThe workbook object associated with the equation
parentEquationNodeThe 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:

ParameterTypeDescription
objjava.lang.ObjectThe 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:

ParameterTypeDescription
indexintIndex of the node

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

getChrType()

public int getChrType()

Specify combining characters by type value.

See EquationCombiningCharacterType.

Returns: int

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

getGroupChr()

public String getGroupChr()

Specifies a symbol(default U+23DF). It is strongly recommended to use attribute ChrType to set accent character. 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

getLength()

public int getLength()

Gets the length of the characters.

Returns: int

getParentNode()

public EquationNode getParentNode()

Specifies the parent node of the current node

Returns: EquationNode

getPosition()

public int getPosition()

This attribute specifies the position of the character in the object

See EquationCharacterPositionType.

Returns: int

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

getVertJc()

public int getVertJc()

This attribute, combined with pos of groupChrPr, specifies the vertical layout of the groupChr object. Where pos specifies the position of the grouping character, vertJc specifies the alignment of the object with respect to the baseline.

See EquationCharacterPositionType.

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:

ParameterTypeDescription
equationTypeintEquationNodeType. 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:

ParameterTypeDescription
equationTypeintEquationNodeType. 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:

ParameterTypeDescription
indexintindex value
equationTypeintEquationNodeType. 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.

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:

ParameterTypeDescription
nodeEquationNodeNode 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:

ParameterTypeDescription
indexintIndex of the node

setChrType(int value)

public void setChrType(int value)

Specify combining characters by type value.

See EquationCombiningCharacterType.

Parameters:

ParameterTypeDescription
valueint

setGroupChr(String value)

public void setGroupChr(String value)

Specifies a symbol(default U+23DF). It is strongly recommended to use attribute ChrType to set accent character. 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.

Parameters:

ParameterTypeDescription
valuejava.lang.String

setParentNode(EquationNode value)

public void setParentNode(EquationNode value)

Specifies the parent node of the current node

Parameters:

ParameterTypeDescription
valueEquationNode

setPosition(int value)

public void setPosition(int value)

This attribute specifies the position of the character in the object

See EquationCharacterPositionType.

Parameters:

ParameterTypeDescription
valueint

setVertJc(int value)

public void setVertJc(int value)

This attribute, combined with pos of groupChrPr, specifies the vertical layout of the groupChr object. Where pos specifies the position of the grouping character, vertJc specifies the alignment of the object with respect to the baseline.

See EquationCharacterPositionType.

Parameters:

ParameterTypeDescription
valueint

setWordArtStyle(int style)

public void setWordArtStyle(int style)

Sets the preset WordArt style.

Remarks

Only for the text of shape/chart.

Parameters:

ParameterTypeDescription
styleintPresetWordArtStyle. 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:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int