com.aspose.words

Classes

Exceptions

Constants

com.aspose.words

Class MathObjectType

java.lang.Object
- com.aspose.words.MathObjectType

public class MathObjectType extends java.lang.Object

Utility class containing constants. Specifies type of an Office Math object.

Example:

Shows how to print the node structure of every office math node in a document.

public void officeMathToText() throws Exception {
    Document doc = new Document(getMyDir() + "DocumentVisitor-compatible features.docx");
    OfficeMathStructurePrinter visitor = new OfficeMathStructurePrinter();

    // When we get a composite node to accept a document visitor, the visitor visits the accepting node,
    // and then traverses all of the node's children in a depth-first manner.
    // The visitor can read and modify each visited node.
    doc.accept(visitor);

    System.out.println(visitor.getText());
}

/// <summary>
/// Traverses a node's non-binary tree of child nodes.
/// Creates a map in the form of a string of all encountered OfficeMath nodes and their children.
/// </summary>
public static class OfficeMathStructurePrinter extends DocumentVisitor {
    public OfficeMathStructurePrinter() {
        mBuilder = new StringBuilder();
        mVisitorIsInsideOfficeMath = false;
    }

    /// <summary>
    /// Gets the plain text of the document that was accumulated by the visitor.
    /// </summary>
    public String getText() {
        return mBuilder.toString();
    }

    /// <summary>
    /// Called when a Run node is encountered in the document.
    /// </summary>
    public int visitRun(final Run run) {
        if (mVisitorIsInsideOfficeMath) {
            indentAndAppendLine("[Run] \"" + run.getText() + "\"");
        }

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when an OfficeMath node is encountered in the document.
    /// </summary>
    public int visitOfficeMathStart(final OfficeMath officeMath) {
        indentAndAppendLine("[OfficeMath start] Math object type: " + officeMath.getMathObjectType());
        mDocTraversalDepth++;
        mVisitorIsInsideOfficeMath = true;

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called after all the child nodes of an OfficeMath node have been visited.
    /// </summary>
    public int visitOfficeMathEnd(final OfficeMath officeMath) {
        mDocTraversalDepth--;
        indentAndAppendLine("[OfficeMath end]");
        mVisitorIsInsideOfficeMath = false;

        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Append a line to the StringBuilder and indent it depending on how deep the visitor is into the document tree.
    /// </summary>
    /// <param name="text"></param>
    private void indentAndAppendLine(final String text) {
        for (int i = 0; i < mDocTraversalDepth; i++) {
            mBuilder.append("|  ");
        }

        mBuilder.append(text + "\r\n");
    }

    private boolean mVisitorIsInsideOfficeMath;
    private int mDocTraversalDepth;
    private StringBuilder mBuilder;
}

Field Summary
`static final int`	`O_MATH = 0`
`static final int`	Instance of mathematical text.
`static final int`	`O_MATH_PARA = 1`
`static final int`	Math paragraph, or display math zone, that contains one or more O_MATH elements that are in display mode.
`static final int`	`ACCENT = 2`
`static final int`	Accent function, consisting of a base and a combining diacritical mark.
`static final int`	`BAR = 3`
`static final int`	Bar function, consisting of a base argument and an overbar or underbar.
`static final int`	`BORDER_BOX = 4`
`static final int`	Border Box object, consisting of a border drawn around an instance of mathematical text (such as a formula or equation)
`static final int`	`BOX = 5`
`static final int`	Box object, which is used to group components of an equation or other instance of mathematical text.
`static final int`	`DELIMITER = 6`
`static final int`	Delimiter object, consisting of opening and closing delimiters (such as parentheses, braces, brackets, and vertical bars), and an element contained inside.
`static final int`	`DEGREE = 7`
`static final int`	Degree in the mathematical radical.
`static final int`	`ARGUMENT = 8`
`static final int`	Argument object. Encloses Office Math entities when they are used as arguments to other Office Math entities.
`static final int`	`ARRAY = 9`
`static final int`	Array object, consisting of one or more equations, expressions, or other mathematical text runs that can be vertically justified as a unit with respect to surrounding text on the line.
`static final int`	`FRACTION = 10`
`static final int`	Fraction object, consisting of a numerator and denominator separated by a fraction bar.
`static final int`	`DENOMINATOR = 11`
`static final int`	Denominator of a fraction object.
`static final int`	`NUMERATOR = 12`
`static final int`	Numerator of the Fraction object.
`static final int`	`FUNCTION = 13`
`static final int`	Function-Apply object, which consists of a function name and an argument element acted upon.
`static final int`	`FUNCTION_NAME = 14`
`static final int`	Name of the function. For example, function names are sin and cos.
`static final int`	`GROUP_CHARACTER = 15`
`static final int`	Group-Character object, consisting of a character drawn above or below text, often with the purpose of visually grouping items
`static final int`	`LIMIT = 16`
`static final int`	Lower limit of the LOWER_LIMIT object and the upper limit of the UPPER_LIMIT function.
`static final int`	`LOWER_LIMIT = 17`
`static final int`	Lower-Limit object, consisting of text on the baseline and reduced-size text immediately below it.
`static final int`	`UPPER_LIMIT = 18`
`static final int`	Upper-Limit object, consisting of text on the baseline and reduced-size text immediately above it.
`static final int`	`MATRIX = 19`
`static final int`	Matrix object, consisting of one or more elements laid out in one or more rows and one or more columns.
`static final int`	`MATRIX_ROW = 20`
`static final int`	Single row of the matrix.
`static final int`	`N_ARY = 21`
`static final int`	N-ary object, consisting of an n-ary object, a base (or operand), and optional upper and lower limits.
`static final int`	`PHANTOM = 22`
`static final int`	Phantom object.
`static final int`	`RADICAL = 23`
`static final int`	Radical object, consisting of a radical, a base element, and an optional degree .
`static final int`	`SUBSCRIPT_PART = 24`
`static final int`	Subscript of the object that can have subscript part.
`static final int`	`SUPERSCRIPT_PART = 25`
`static final int`	Superscript of the superscript object.
`static final int`	`PRE_SUB_SUPERSCRIPT = 26`
`static final int`	Pre-Sub-Superscript object, which consists of a base element and a subscript and superscript placed to the left of the base.
`static final int`	`SUBSCRIPT = 27`
`static final int`	Subscript object, which consists of a base element and a reduced-size script placed below and to the right.
`static final int`	`SUB_SUPERSCRIPT = 28`
`static final int`	Sub-superscript object, which consists of a base element, a reduced-size script placed below and to the right, and a reduced-size script placed above and to the right.
`static final int`	`SUPERCRIPT = 29`
`static final int`	Superscript object, which consists of a base element and a reduced-size script placed above and to the right.

- Field Detail
  - O_MATH = 0
```
public static final int O_MATH
```
    Instance of mathematical text.
  - O_MATH_PARA = 1
```
public static final int O_MATH_PARA
```
    Math paragraph, or display math zone, that contains one or more O_MATH elements that are in display mode.
  - ACCENT = 2
```
public static final int ACCENT
```
    Accent function, consisting of a base and a combining diacritical mark.
  - BAR = 3
```
public static final int BAR
```
    Bar function, consisting of a base argument and an overbar or underbar.
  - BORDER_BOX = 4
```
public static final int BORDER_BOX
```
    Border Box object, consisting of a border drawn around an instance of mathematical text (such as a formula or equation)
  - BOX = 5
```
public static final int BOX
```
    Box object, which is used to group components of an equation or other instance of mathematical text.
  - DELIMITER = 6
```
public static final int DELIMITER
```
    Delimiter object, consisting of opening and closing delimiters (such as parentheses, braces, brackets, and vertical bars), and an element contained inside.
  - DEGREE = 7
```
public static final int DEGREE
```
    Degree in the mathematical radical.
  - ARGUMENT = 8
```
public static final int ARGUMENT
```
    Argument object. Encloses Office Math entities when they are used as arguments to other Office Math entities.
  - ARRAY = 9
```
public static final int ARRAY
```
    Array object, consisting of one or more equations, expressions, or other mathematical text runs that can be vertically justified as a unit with respect to surrounding text on the line.
  - FRACTION = 10
```
public static final int FRACTION
```
    Fraction object, consisting of a numerator and denominator separated by a fraction bar.
  - DENOMINATOR = 11
```
public static final int DENOMINATOR
```
    Denominator of a fraction object.
  - NUMERATOR = 12
```
public static final int NUMERATOR
```
    Numerator of the Fraction object.
  - FUNCTION = 13
```
public static final int FUNCTION
```
    Function-Apply object, which consists of a function name and an argument element acted upon.
  - FUNCTION_NAME = 14
```
public static final int FUNCTION_NAME
```
    Name of the function. For example, function names are sin and cos.
  - GROUP_CHARACTER = 15
```
public static final int GROUP_CHARACTER
```
    Group-Character object, consisting of a character drawn above or below text, often with the purpose of visually grouping items
  - LIMIT = 16
```
public static final int LIMIT
```
    Lower limit of the LOWER_LIMIT object and the upper limit of the UPPER_LIMIT function.
  - LOWER_LIMIT = 17
```
public static final int LOWER_LIMIT
```
    Lower-Limit object, consisting of text on the baseline and reduced-size text immediately below it.
  - UPPER_LIMIT = 18
```
public static final int UPPER_LIMIT
```
    Upper-Limit object, consisting of text on the baseline and reduced-size text immediately above it.
  - MATRIX = 19
```
public static final int MATRIX
```
    Matrix object, consisting of one or more elements laid out in one or more rows and one or more columns.
  - MATRIX_ROW = 20
```
public static final int MATRIX_ROW
```
    Single row of the matrix.
  - N_ARY = 21
```
public static final int N_ARY
```
    N-ary object, consisting of an n-ary object, a base (or operand), and optional upper and lower limits.
  - PHANTOM = 22
```
public static final int PHANTOM
```
    Phantom object.
  - RADICAL = 23
```
public static final int RADICAL
```
    Radical object, consisting of a radical, a base element, and an optional degree .
  - SUBSCRIPT_PART = 24
```
public static final int SUBSCRIPT_PART
```
    Subscript of the object that can have subscript part.
  - SUPERSCRIPT_PART = 25
```
public static final int SUPERSCRIPT_PART
```
    Superscript of the superscript object.
  - PRE_SUB_SUPERSCRIPT = 26
```
public static final int PRE_SUB_SUPERSCRIPT
```
    Pre-Sub-Superscript object, which consists of a base element and a subscript and superscript placed to the left of the base.
  - SUBSCRIPT = 27
```
public static final int SUBSCRIPT
```
    Subscript object, which consists of a base element and a reduced-size script placed below and to the right.
  - SUB_SUPERSCRIPT = 28
```
public static final int SUB_SUPERSCRIPT
```
    Sub-superscript object, which consists of a base element, a reduced-size script placed below and to the right, and a reduced-size script placed above and to the right.
  - SUPERCRIPT = 29
```
public static final int SUPERCRIPT
```
    Superscript object, which consists of a base element and a reduced-size script placed above and to the right.

com.aspose.words

Classes

Interfaces

Exceptions

Constants

Class MathObjectType

Field Detail

O_MATH = 0

O_MATH_PARA = 1

ACCENT = 2

BAR = 3

BORDER_BOX = 4

BOX = 5

DELIMITER = 6

DEGREE = 7

ARGUMENT = 8

ARRAY = 9

FRACTION = 10

DENOMINATOR = 11

NUMERATOR = 12

FUNCTION = 13

FUNCTION_NAME = 14

GROUP_CHARACTER = 15

LIMIT = 16

LOWER_LIMIT = 17

UPPER_LIMIT = 18

MATRIX = 19

MATRIX_ROW = 20

N_ARY = 21

PHANTOM = 22

RADICAL = 23

SUBSCRIPT_PART = 24

SUPERSCRIPT_PART = 25

PRE_SUB_SUPERSCRIPT = 26

SUBSCRIPT = 27

SUB_SUPERSCRIPT = 28

SUPERCRIPT = 29