com.aspose.slides

Interfaces

Classes

Exceptions

com.aspose.slides

Interface IMathBox

  • All Superinterfaces:
    IMathElement
    All Known Implementing Classes:
    MathBox


    public interface IMathBox
    extends IMathElement

    Specifies the logical boxing (packaging) of mathematical element. For example, a boxed object can serve as an operator emulator with or without an alignment point, serve as a line break point, or be grouped such as not to allow line breaks within. For example, the "==" operator should be boxed to prevent line breaks.


    Example:
     
     IMathBox box = new MathematicalText("==").toBox();
     
    • Method Detail

      • getBase

        IMathElement getBase()

        Base argument


        Example:
         
         IMathBox box = new MathematicalText("==").toBox();
         IMathElement base = box.getBase();
         
      • getOperatorEmulator

        boolean getOperatorEmulator()

        Operator Emulator. When true, the box and its contents behave as a single operator and inherit the properties of an operator. This means, for example, that the character can serve as a point for a line break and can be aligned to other operators. Operator Emulators are often used when one or more glyphs combine to form an operator, such as '=='. Default value: false


        Example:
         
         IMathBox box = new MathematicalText("==").toBox();
         box.setOperatorEmulator(true);
         
      • setOperatorEmulator

        void setOperatorEmulator(boolean value)

        Operator Emulator. When true, the box and its contents behave as a single operator and inherit the properties of an operator. This means, for example, that the character can serve as a point for a line break and can be aligned to other operators. Operator Emulators are often used when one or more glyphs combine to form an operator, such as '=='. Default value: false


        Example:
         
         IMathBox box = new MathematicalText("==").toBox();
         box.setOperatorEmulator(true);
         
      • getNoBreak

        boolean getNoBreak()

        No break. This property specifies the "unbreakable" property on the object box. When true, no line breaks can occur within the box. This can be important for operator emulators that consist of more than one binary operator. When this element is not specified, breaks can occur inside box. Default: true


        Example:
         
         IMathBox box = new MathematicalText("**********").toBox();
         box.setNoBreak(false);
         
      • setNoBreak

        void setNoBreak(boolean value)

        No break. This property specifies the "unbreakable" property on the object box. When true, no line breaks can occur within the box. This can be important for operator emulators that consist of more than one binary operator. When this element is not specified, breaks can occur inside box. Default: true


        Example:
         
         IMathBox box = new MathematicalText("**********").toBox();
         box.setNoBreak(false);
         
      • getDifferential

        boolean getDifferential()

        Differential. When true, the box acts as a differential (e.g., 𝑑𝑥 in an integrand), and receives the appropriate horizontal spacing for the mathematical differential. Default: false


        Example:
         
         IMathBox differential = new MathematicalText("dx").toBox();
         differential.setDifferential(true);
         IMathBlock baseArg = new MathematicalText("x").join(differential);
         IMathNaryOperator integral = baseArg.integral(MathIntegralTypes.Simple, "0", "1");
         
      • setDifferential

        void setDifferential(boolean value)

        Differential. When true, the box acts as a differential (e.g., 𝑑𝑥 in an integrand), and receives the appropriate horizontal spacing for the mathematical differential. Default: false


        Example:
         
         IMathBox differential = new MathematicalText("dx").toBox();
         differential.setDifferential(true);
         IMathBlock baseArg = new MathematicalText("x").join(differential);
         IMathNaryOperator integral = baseArg.integral(MathIntegralTypes.Simple, "0", "1");
         
      • getAlignmentPoint

        boolean getAlignmentPoint()

        When true, this operator emulator serves as an alignment point; that is, designated alignment points in other equations can be aligned with it. Default: false


        Example:
         
         IMathBox box = new MathematicalText("==").toBox();
         box.setAlignmentPoint(true);
         
      • setAlignmentPoint

        void setAlignmentPoint(boolean value)

        When true, this operator emulator serves as an alignment point; that is, designated alignment points in other equations can be aligned with it. Default: false


        Example:
         
         IMathBox box = new MathematicalText("==").toBox();
         box.setAlignmentPoint(true);
         
      • getExplicitBreak

        byte getExplicitBreak()

        Explicit break specifies whether there is a line break at the start of the Box object, such that the line wraps at the start of the box object. Specifies the number of the operator on the previous line of mathematical text which shall be used as the alignment point for the current line of mathematical text possible values: 1..255 Default: 0 (no explicit break)


        Example:
         
         IMathBox box = new MathematicalText("==").toBox();
         box.setExplicitBreak(1);
         
      • setExplicitBreak

        void setExplicitBreak(byte value)

        Explicit break specifies whether there is a line break at the start of the Box object, such that the line wraps at the start of the box object. Specifies the number of the operator on the previous line of mathematical text which shall be used as the alignment point for the current line of mathematical text possible values: 1..255 Default: 0 (no explicit break)


        Example:
         
         IMathBox box = new MathematicalText("==").toBox();
         box.setExplicitBreak(1);