MathBox

Inheritance: java.lang.Object, com.aspose.slides.MathElementBase

All Implemented Interfaces: com.aspose.slides.IMathBox, com.aspose.slides.IHasControlCharacterProperties

public final class MathBox extends MathElementBase implements IMathBox, IHasControlCharacterProperties

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:
 
 MathBox box = new MathBox(new MathematicalText("=="));

Constructors

Constructor	Description
MathBox(IMathElement element)	Initializes MathBox with the specified element as an argument

Methods

Method	Description
getBase()	Base argument
getOperatorEmulator()	Operator Emulator.
setOperatorEmulator(boolean value)	Operator Emulator.
getNoBreak()	No break This property specifies the “unbreakable” property on the object box.
setNoBreak(boolean value)	No break This property specifies the “unbreakable” property on the object box.
getDifferential()	Differential When true, the box acts as a differential (e.g., \ud835\udc51\ud835\udc65 in an integrand), and receives the appropriate horizontal spacing for the mathematical differential.
setDifferential(boolean value)	Differential When true, the box acts as a differential (e.g., \ud835\udc51\ud835\udc65 in an integrand), and receives the appropriate horizontal spacing for the mathematical differential.
getAlignmentPoint()	When true, this operator emulator serves as an alignment point; that is, designated alignment points in other equations can be aligned with it.
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.
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.
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.
getChildren()	Get children elements
getControlCharacterProperties()	Control Character Properties

MathBox(IMathElement element)

public MathBox(IMathElement element)

Initializes MathBox with the specified element as an argument

Example:
 
 MathBox box = new MathBox(new MathematicalText("=="));

Parameters:

Parameter	Type	Description
element	IMathElement	The base element to which the box is applied. Can be null.

getBase()

public final IMathElement getBase()

Base argument

Example:
 
 MathBox box = new MathBox(new MathematicalText("=="));
 IMathElement base = box.getBase();

Returns: IMathElement

getOperatorEmulator()

public final 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:
 
 MathBox box = new MathBox(new MathematicalText("=="));
 box.setOperatorEmulator(true);

Returns: boolean

setOperatorEmulator(boolean value)

public final void setOperatorEmulator(boolean value)

Example:
 
 MathBox box = new MathBox(new MathematicalText("=="));
 box.setOperatorEmulator(true);

Parameters:

Parameter	Type	Description
value	boolean

getNoBreak()

public final 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:
 
 MathBox box = new MathBox(new MathematicalText("*****"));
 box.setNoBreak(false);

Returns: boolean

setNoBreak(boolean value)

public final void setNoBreak(boolean value)

Example:
 
 MathBox box = new MathBox(new MathematicalText("*****"));
 box.setNoBreak(false);

Parameters:

Parameter	Type	Description
value	boolean

getDifferential()

public final boolean getDifferential()

Differential When true, the box acts as a differential (e.g., \ud835\udc51\ud835\udc65 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");

Returns: boolean

setDifferential(boolean value)

public final void setDifferential(boolean value)

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");

Parameters:

Parameter	Type	Description
value	boolean

getAlignmentPoint()

public final 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);

Returns: boolean

setAlignmentPoint(boolean value)

public final 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);

Parameters:

Parameter	Type	Description
value	boolean

getExplicitBreak()

public final 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);

Returns: byte

setExplicitBreak(byte value)

public final void setExplicitBreak(byte value)

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

Parameters:

Parameter	Type	Description
value	byte

getChildren()

public final IMathElement[] getChildren()

Get children elements

Returns: com.aspose.slides.IMathElement[]

getControlCharacterProperties()

public final OmmlControlCharacterPPTXUnsupportedProps getControlCharacterProperties()

Control Character Properties

Returns: com.aspose.slides.OmmlControlCharacterPPTXUnsupportedProps