public interface IMathDelimiter extends IMathElement
Specifies the delimiter object, consisting of opening and closing characters (such as parentheses, braces, brackets, and vertical bars), and one or more mathematical elements inside, separated by a specified character. Examples: (𝑥2); [𝑥2|𝑦2]
Example:IMathElement element = new MathematicalText("x"); IMathDelimiter delimiter = element.enclose();
Modifier and Type | Method and Description |
---|---|
IMathDelimiter |
delimit(char separatorCharacter)
Delimits arguments using the specified delimiter character
|
IMathElementCollection |
getArguments()
One or more mathematical elements separated by delimiter characters
|
char |
getBeginningCharacter()
Delimiter Beginning Character specifies the beginning, or opening, delimiter character.
|
int |
getDelimiterShape()
Specifies the shape of delimiters in the delimiter object.
|
char |
getEndingCharacter()
Delimiter Ending Character specifies the ending, or closing, delimiter character.
|
boolean |
getGrowToMatchOperandHeight()
Specifies the growth of BeginningCharacter, SeparatorCharacter, EndingCharacter
When true, the delimiters grows vertically to match its operand height.
|
char |
getSeparatorCharacter()
Delimiter Separator Character specifies the character that separates arguments in the delimiter object.
|
void |
setBeginningCharacter(char value)
Delimiter Beginning Character specifies the beginning, or opening, delimiter character.
|
void |
setDelimiterShape(int value)
Specifies the shape of delimiters in the delimiter object.
|
void |
setEndingCharacter(char value)
Delimiter Ending Character specifies the ending, or closing, delimiter character.
|
void |
setGrowToMatchOperandHeight(boolean value)
Specifies the growth of BeginningCharacter, SeparatorCharacter, EndingCharacter
When true, the delimiters grows vertically to match its operand height.
|
void |
setSeparatorCharacter(char value)
Delimiter Separator Character specifies the character that separates arguments in the delimiter object.
|
accent, asArgumentOfFunction, asArgumentOfFunction, asArgumentOfFunction, asArgumentOfFunction, asArgumentOfFunction, divide, divide, divide, divide, enclose, enclose, function, function, getChildren, 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, underbar
IMathElementCollection getArguments()
One or more mathematical elements separated by delimiter characters
Example:IMathDelimiter delimiter = new MathematicalText("x").join("y").enclose(); IMathElementCollection arguments = delimiter.getArguments();
char getBeginningCharacter()
Delimiter Beginning Character specifies the beginning, or opening, delimiter character. Mathematical delimiters are enclosing characters such as parentheses, brackets, and braces. The default value: '('.
Example:IMathDelimiter delimiter = new MathematicalText("x").join("y").enclose(); delimiter.setBeginningCharacter('[');
void setBeginningCharacter(char value)
Delimiter Beginning Character specifies the beginning, or opening, delimiter character. Mathematical delimiters are enclosing characters such as parentheses, brackets, and braces. The default value: '('.
Example:IMathDelimiter delimiter = new MathematicalText("x").join("y").enclose(); delimiter.setBeginningCharacter('[');
char getSeparatorCharacter()
Delimiter Separator Character specifies the character that separates arguments in the delimiter object. The default: '|'.
Example:IMathDelimiter delimiter = new MathematicalText("x").join("y").enclose(); delimiter.setSeparatorCharacter('$');
void setSeparatorCharacter(char value)
Delimiter Separator Character specifies the character that separates arguments in the delimiter object. The default: '|'.
Example:IMathDelimiter delimiter = new MathematicalText("x").join("y").enclose(); delimiter.setSeparatorCharacter('$');
char getEndingCharacter()
Delimiter Ending Character specifies the ending, or closing, delimiter character. Mathematical delimiters are enclosing characters such as parentheses, brackets, and braces. The default: ')'.
Example:IMathDelimiter delimiter = new MathematicalText("x").join("y").enclose(); delimiter.setEndingCharacter(']');
void setEndingCharacter(char value)
Delimiter Ending Character specifies the ending, or closing, delimiter character. Mathematical delimiters are enclosing characters such as parentheses, brackets, and braces. The default: ')'.
Example:IMathDelimiter delimiter = new MathematicalText("x").join("y").enclose(); delimiter.setEndingCharacter(']');
boolean getGrowToMatchOperandHeight()
Specifies the growth of BeginningCharacter, SeparatorCharacter, EndingCharacter When true, the delimiters grows vertically to match its operand height. The default value is true
Example:IMathDelimiter delimiter = new MathematicalText("x").divide("y").enclose(); delimiter.setGrowToMatchOperandHeight(false);
void setGrowToMatchOperandHeight(boolean value)
Specifies the growth of BeginningCharacter, SeparatorCharacter, EndingCharacter When true, the delimiters grows vertically to match its operand height. The default value is true
Example:IMathDelimiter delimiter = new MathematicalText("x").divide("y").enclose(); delimiter.setGrowToMatchOperandHeight(false);
int getDelimiterShape()
Specifies the shape of delimiters in the delimiter object. When is MathDelimiterShape.Centered, delimiters are centered around the math axis of the mathematical text and still be made to fit the entire height of their contents. When is MathDelimiterShape.Match, their height and shape are altered to exactly match their contents.
Example:IMathDelimiter delimiter = new MathematicalText("x").divide("y").enclose(); delimiter.setDelimiterShape(MathDelimiterShape.Match);
void setDelimiterShape(int value)
Specifies the shape of delimiters in the delimiter object. When is MathDelimiterShape.Centered, delimiters are centered around the math axis of the mathematical text and still be made to fit the entire height of their contents. When is MathDelimiterShape.Match, their height and shape are altered to exactly match their contents.
Example:IMathDelimiter delimiter = new MathematicalText("x").divide("y").enclose(); delimiter.setDelimiterShape(MathDelimiterShape.Match);
IMathDelimiter delimit(char separatorCharacter)
Delimits arguments using the specified delimiter character
Example:IMathDelimiter delimiter = new MathematicalText("x").join("y").enclose(); delimiter.delimit('|');
separatorCharacter
- delimiter character