public final class MathBox extends MathElementBase implements IMathBox
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("=="));
| Constructor and Description |
|---|
MathBox(IMathElement element)
Initializes MathBox with the specified element as an argument
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
IMathElement |
getBase()
Base argument
|
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.
|
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.
|
boolean |
getNoBreak()
No break
This property specifies the "unbreakable" property on the object box.
|
boolean |
getOperatorEmulator()
Operator Emulator.
|
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.
|
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.
|
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.
|
void |
setNoBreak(boolean value)
No break
This property specifies the "unbreakable" property on the object box.
|
void |
setOperatorEmulator(boolean value)
Operator Emulator.
|
accent, asArgumentOfFunction, asArgumentOfFunction, asArgumentOfFunction, asArgumentOfFunction, asArgumentOfFunction, divide, divide, divide, divide, enclose, enclose, function, function, getParent_Immediate, group, group, integral, integral, integral, integral, integral, join, join, nary, nary, overbar, radical, radical, setLowerLimit, setLowerLimit, setSubscript, setSubscript, setSubSuperscriptOnTheLeft, setSubSuperscriptOnTheLeft, setSubSuperscriptOnTheRight, setSubSuperscriptOnTheRight, setSuperscript, setSuperscript, setUpperLimit, setUpperLimit, toBorderBox, toBorderBox, toBox, toMathArray, underbarequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaccent, asArgumentOfFunction, asArgumentOfFunction, asArgumentOfFunction, asArgumentOfFunction, asArgumentOfFunction, divide, divide, divide, divide, enclose, enclose, function, function, group, group, integral, integral, integral, integral, integral, join, join, nary, nary, overbar, radical, radical, setLowerLimit, setLowerLimit, setSubscript, setSubscript, setSubSuperscriptOnTheLeft, setSubSuperscriptOnTheLeft, setSubSuperscriptOnTheRight, setSubSuperscriptOnTheRight, setSuperscript, setSuperscript, setUpperLimit, setUpperLimit, toBorderBox, toBorderBox, toBox, toMathArray, underbarpublic MathBox(IMathElement element)
Initializes MathBox with the specified element as an argument
Example:MathBox box = new MathBox(new MathematicalText("=="));
element - The base element to which the box is applied. Can be null.public final IMathElement getBase()
Base argument
Example:MathBox box = new MathBox(new MathematicalText("==")); IMathElement base = box.getBase();
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);
getOperatorEmulator in interface IMathBoxpublic final 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:MathBox box = new MathBox(new MathematicalText("==")); box.setOperatorEmulator(true);
setOperatorEmulator in interface IMathBoxpublic 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);
getNoBreak in interface IMathBoxpublic final 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:MathBox box = new MathBox(new MathematicalText("*****")); box.setNoBreak(false);
setNoBreak in interface IMathBoxpublic final 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");
getDifferential in interface IMathBoxpublic final 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");
setDifferential in interface IMathBoxpublic 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);
getAlignmentPoint in interface IMathBoxpublic 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);
setAlignmentPoint in interface IMathBoxpublic 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);
getExplicitBreak in interface IMathBoxpublic final 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);
setExplicitBreak in interface IMathBox