MathBox
MathBox class
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.
MathBox
| Name | Description |
|---|---|
| MathBox(MathLeftSubSuperscriptElement) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathLeftSubSuperscriptElement | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathLimit) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathLimit | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathMatrix) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathMatrix | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathBlock) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathBlock | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathRadical) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathRadical | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathArray) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathArray | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathDelimiter) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathDelimiter | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathNaryOperator) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathNaryOperator | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathAccent) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathAccent | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathGroupingCharacter) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathGroupingCharacter | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathBorderBox) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathBorderBox | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathBar) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathBar | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathSuperscriptElement) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathSuperscriptElement | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathSubscriptElement) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathSubscriptElement | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathFunction) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathFunction | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathematicalText) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathematicalText | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathFraction) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathFraction | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(BaseScript) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | BaseScript | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathBox) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathBox | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathElementBase) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathElementBase | The base element to which the box is applied. Can be null. |
Returns: MathBox
MathBox
| Name | Description |
|---|---|
| MathBox(MathRightSubSuperscriptElement) | Initializes MathBox with the specified element as an argument |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | MathRightSubSuperscriptElement | The base element to which the box is applied. Can be null. |
Returns: MathBox
getAlignmentPoint
| Name | Description |
|---|---|
| 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 |
Returns: boolean
getBase
| Name | Description |
|---|---|
| getBase () | Base argument |
Returns: MathLeftSubSuperscriptElement, MathLimit, MathMatrix, MathBlock, MathRadical, MathArray, MathDelimiter, MathNaryOperator, MathAccent, MathGroupingCharacter, MathBorderBox, MathBar, MathSuperscriptElement, MathSubscriptElement, MathFunction, MathematicalText, MathFraction, BaseScript, MathBox, MathElementBase, MathRightSubSuperscriptElement
getChildren
| Name | Description |
|---|---|
| getChildren () | Get children elements |
Returns: MathLeftSubSuperscriptElement, MathLimit, MathMatrix, MathBlock, MathRadical, MathArray, MathDelimiter, MathNaryOperator, MathAccent, MathGroupingCharacter, MathBorderBox, MathBar, MathSuperscriptElement, MathSubscriptElement, MathFunction, MathematicalText, MathFraction, BaseScript, MathBox, MathElementBase, MathRightSubSuperscriptElement
getDifferential
| Name | Description |
|---|---|
| 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 |
Returns: boolean
getExplicitBreak
| Name | Description |
|---|---|
| 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) |
Returns: byte
getNoBreak
| Name | Description |
|---|---|
| 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 |
Returns: boolean
getOperatorEmulator
| Name | Description |
|---|---|
| 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 |
Returns: boolean
setAlignmentPoint
| Name | Description |
|---|---|
| setAlignmentPoint (boolean) | 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 |
Returns: void
setDifferential
| Name | Description |
|---|---|
| setDifferential (boolean) | 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 |
Returns: void
setExplicitBreak
| Name | Description |
|---|---|
| setExplicitBreak (byte) | 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) |
Returns: void
setNoBreak
| Name | Description |
|---|---|
| setNoBreak (boolean) | 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 |
Returns: void
setOperatorEmulator
| Name | Description |
|---|---|
| setOperatorEmulator (boolean) | 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 |
Returns: void