com.aspose.slides

Class MathBorderBox

java.lang.Object

com.aspose.slides.MathElementBase

com.aspose.slides.MathBorderBox

All Implemented Interfaces:

IMathBorderBox, IMathElement

public final class MathBorderBox
extends MathElementBase
implements IMathBorderBox

Draws a rectangular or some other border around the IMathElement.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 
 

Constructor Summary

Constructors

Constructor and Description
MathBorderBox(IMathElement element) Creates MathBorderBox element with rectangular border
MathBorderBox(IMathElement element, boolean hideTop, boolean hideBottom, boolean hideLeft, boolean hideRight, boolean strikethroughHorizontal, boolean strikethroughVertical, boolean strikethroughBottomLeftToTopRight, boolean strikethroughTopLeftToBottomRight) Creates MathBorderBox element

Method Summary

Modifier and Type	Method and Description
IMathElement	getBase() Base argument
IMathElement[]	getChildren() Get children elements
com.aspose.slides.OmmlControlCharacterPPTXUnsupportedProps	getControlCharacterProperties() Control Character Properties
boolean	getHideBottom() Hide Bottom Edge (default is false) - specifies the hidden or shown state of the bottom edge of border box.
boolean	getHideLeft() Hide Left Edge (default is false) - specifies the hidden or shown state of the left edge of border box.
boolean	getHideRight() Hide Right Edge (default is false) - specifies the hidden or shown state of the right edge of border box.
boolean	getHideTop() Hide Top Edge (default is false) - specifies the hidden or shown state of the top edge of border box.
boolean	getStrikethroughBottomLeftToTopRight() Strikethrough Bottom-Left to Top-Right (default is false).
boolean	getStrikethroughHorizontal() Strikethrough Horizontal (default is false) - specifies the hidden or shown state of a strikethrough horizontal line.
boolean	getStrikethroughTopLeftToBottomRight() Strikethrough Top-Left to Bottom-Right (default is false).
boolean	getStrikethroughVertical() Strikethrough Vertical (default is false) - specifies the hidden or shown state of a strikethrough vertical line.
void	setHideBottom(boolean value) Hide Bottom Edge (default is false) - specifies the hidden or shown state of the bottom edge of border box.
void	setHideLeft(boolean value) Hide Left Edge (default is false) - specifies the hidden or shown state of the left edge of border box.
void	setHideRight(boolean value) Hide Right Edge (default is false) - specifies the hidden or shown state of the right edge of border box.
void	setHideTop(boolean value) Hide Top Edge (default is false) - specifies the hidden or shown state of the top edge of border box.
void	setStrikethroughBottomLeftToTopRight(boolean value) Strikethrough Bottom-Left to Top-Right (default is false).
void	setStrikethroughHorizontal(boolean value) Strikethrough Horizontal (default is false) - specifies the hidden or shown state of a strikethrough horizontal line.
void	setStrikethroughTopLeftToBottomRight(boolean value) Strikethrough Top-Left to Bottom-Right (default is false).
void	setStrikethroughVertical(boolean value) Strikethrough Vertical (default is false) - specifies the hidden or shown state of a strikethrough vertical line.

Methods inherited from class com.aspose.slides.MathElementBase

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, underbar

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspose.slides.IMathElement

accent, 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, underbar

Constructor Detail

MathBorderBox

public MathBorderBox(IMathElement element)

Creates MathBorderBox element with rectangular border

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 
 

Parameters:

element - The base element to which the border box is applied. Can be null.

MathBorderBox

public MathBorderBox(IMathElement element,
                     boolean hideTop,
                     boolean hideBottom,
                     boolean hideLeft,
                     boolean hideRight,
                     boolean strikethroughHorizontal,
                     boolean strikethroughVertical,
                     boolean strikethroughBottomLeftToTopRight,
                     boolean strikethroughTopLeftToBottomRight)

Creates MathBorderBox element

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"), true, true, true, false, true, true, true, true)
 
 

Parameters:

element - The base element to which the border box is applied

hideTop - Hide Top Edge

hideBottom - Hide Bottom Edge

hideLeft - Hide Left Edge

hideRight - Hide Right Edge

strikethroughHorizontal - Strikethrough Horizontal

strikethroughVertical - Strikethrough Vertical

strikethroughBottomLeftToTopRight - Strikethrough Bottom-Left to Top-Right

strikethroughTopLeftToBottomRight - Strikethrough Top-Left to Bottom-Right

Method Detail

getBase

public final IMathElement getBase()

Base argument

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 IMathElement base = borderBox.getBase();
 
 

Specified by:

getBase in interface IMathBorderBox

getHideTop

public final boolean getHideTop()

Hide Top Edge (default is false) - specifies the hidden or shown state of the top edge of border box.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setHideTop(true);
 
 

Specified by:

getHideTop in interface IMathBorderBox

setHideTop

public final void setHideTop(boolean value)

Hide Top Edge (default is false) - specifies the hidden or shown state of the top edge of border box.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setHideTop(true);
 
 

Specified by:

setHideTop in interface IMathBorderBox

getHideBottom

public final boolean getHideBottom()

Hide Bottom Edge (default is false) - specifies the hidden or shown state of the bottom edge of border box.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setHideBottom(true);
 
 

Specified by:

getHideBottom in interface IMathBorderBox

setHideBottom

public final void setHideBottom(boolean value)

Hide Bottom Edge (default is false) - specifies the hidden or shown state of the bottom edge of border box.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setHideBottom(true);
 
 

Specified by:

setHideBottom in interface IMathBorderBox

getHideLeft

public final boolean getHideLeft()

Hide Left Edge (default is false) - specifies the hidden or shown state of the left edge of border box.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setHideLeft(true);
 
 

Specified by:

getHideLeft in interface IMathBorderBox

setHideLeft

public final void setHideLeft(boolean value)

Hide Left Edge (default is false) - specifies the hidden or shown state of the left edge of border box.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setHideLeft(true);
 
 

Specified by:

setHideLeft in interface IMathBorderBox

getHideRight

public final boolean getHideRight()

Hide Right Edge (default is false) - specifies the hidden or shown state of the right edge of border box.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setHideRight(true);
 
 

Specified by:

getHideRight in interface IMathBorderBox

setHideRight

public final void setHideRight(boolean value)

Hide Right Edge (default is false) - specifies the hidden or shown state of the right edge of border box.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setHideRight(true);
 
 

Specified by:

setHideRight in interface IMathBorderBox

getStrikethroughHorizontal

public final boolean getStrikethroughHorizontal()

Strikethrough Horizontal (default is false) - specifies the hidden or shown state of a strikethrough horizontal line.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setStrikethroughHorizontal(true);
 
 

Specified by:

getStrikethroughHorizontal in interface IMathBorderBox

setStrikethroughHorizontal

public final void setStrikethroughHorizontal(boolean value)

Strikethrough Horizontal (default is false) - specifies the hidden or shown state of a strikethrough horizontal line.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setStrikethroughHorizontal(true);
 
 

Specified by:

setStrikethroughHorizontal in interface IMathBorderBox

getStrikethroughVertical

public final boolean getStrikethroughVertical()

Strikethrough Vertical (default is false) - specifies the hidden or shown state of a strikethrough vertical line.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setStrikethroughVertical(true);
 
 

Specified by:

getStrikethroughVertical in interface IMathBorderBox

setStrikethroughVertical

public final void setStrikethroughVertical(boolean value)

Strikethrough Vertical (default is false) - specifies the hidden or shown state of a strikethrough vertical line.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setStrikethroughVertical(true);
 
 

Specified by:

setStrikethroughVertical in interface IMathBorderBox

getStrikethroughBottomLeftToTopRight

public final boolean getStrikethroughBottomLeftToTopRight()

Strikethrough Bottom-Left to Top-Right (default is false). Specifies the hidden or shown state of a strikethrough diagonal line from the bottom-left corner to the top-right corner of border box.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setStrikethroughBottomLeftToTopRight(true);
 
 

Specified by:

getStrikethroughBottomLeftToTopRight in interface IMathBorderBox

setStrikethroughBottomLeftToTopRight

public final void setStrikethroughBottomLeftToTopRight(boolean value)

Strikethrough Bottom-Left to Top-Right (default is false). Specifies the hidden or shown state of a strikethrough diagonal line from the bottom-left corner to the top-right corner of border box.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setStrikethroughBottomLeftToTopRight(true);
 
 

Specified by:

setStrikethroughBottomLeftToTopRight in interface IMathBorderBox

getStrikethroughTopLeftToBottomRight

public final boolean getStrikethroughTopLeftToBottomRight()

Strikethrough Top-Left to Bottom-Right (default is false). Specifies the hidden or shown state of a strikethrough diagonal line from the top-left corner to the bottom-right corner of border box.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setStrikethroughTopLeftToBottomRight(true);
 
 

Specified by:

getStrikethroughTopLeftToBottomRight in interface IMathBorderBox

setStrikethroughTopLeftToBottomRight

public final void setStrikethroughTopLeftToBottomRight(boolean value)

Strikethrough Top-Left to Bottom-Right (default is false). Specifies the hidden or shown state of a strikethrough diagonal line from the top-left corner to the bottom-right corner of border box.

Example:
 
 MathBorderBox borderBox = new MathBorderBox(new MathematicalText("x"));
 borderBox.setStrikethroughTopLeftToBottomRight(true);
 
 

Specified by:

setStrikethroughTopLeftToBottomRight in interface IMathBorderBox

getChildren

public final IMathElement[] getChildren()

Get children elements

Specified by:

getChildren in interface IMathElement

Overrides:

getChildren in class MathElementBase

Returns:

Array of IMathElement

getControlCharacterProperties

public final com.aspose.slides.OmmlControlCharacterPPTXUnsupportedProps getControlCharacterProperties()

Control Character Properties