com.aspose.words

Class Border

java.lang.Object

com.aspose.words.InternableComplexAttr

com.aspose.words.Border

All Implemented Interfaces:

java.lang.Cloneable

public class Border
extends InternableComplexAttr
implements java.lang.Cloneable

Represents a border of an object.

To learn more, visit the Programming with Documents documentation article.

Borders can be applied to various document elements including paragraph, run of text inside a paragraph or a table cell.

Method Summary

Modifier and Type	Method and Description
void	clearFormatting() Resets border properties to default values.
boolean	equals(Border rhs) Determines whether the specified border is equal in value to the current border.
boolean	equals(java.lang.Object obj) Determines whether the specified object is equal in value to the current object.
java.awt.Color	getColor() Gets the border color.
double	getDistanceFromText() Gets distance of the border from text or from the page edge in points.
int	getLineStyle() Gets the border style.
double	getLineWidth() Gets the border width in points.
boolean	getShadow() Gets a value indicating whether the border has a shadow.
int	hashCode()
boolean	isInheritedComplexAttr()
boolean	isVisible() Returns true if the LineStyle is not LineStyle.None.
protected java.lang.Object	memberwiseClone()
void	setColor(java.awt.Color value) Sets the border color.
void	setDistanceFromText(double value) Sets distance of the border from text or from the page edge in points.
void	setLineStyle(int value) Sets the border style.
void	setLineWidth(double value) Sets the border width in points.
void	setShadow(boolean value) Sets a value indicating whether the border has a shadow.

Methods inherited from class com.aspose.words.InternableComplexAttr

notifyChanging

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

clearFormatting

public void clearFormatting()

Resets border properties to default values. When border properties are reset to default values, the border is invisible.

getLineStyle

public int getLineStyle()

Gets the border style.

If you set line style to none, then line width is automatically changed to zero.

Returns:

The border style. The returned value is one of LineStyle constants.

setLineStyle

public void setLineStyle(int value)

Sets the border style.

If you set line style to none, then line width is automatically changed to zero.

Parameters:

value - The border style. The value must be one of LineStyle constants.

getLineWidth

public double getLineWidth()

Gets the border width in points.

If you set line width greater than zero when line style is none, the line style is automatically changed to single line.

Returns:

The border width in points.

setLineWidth

public void setLineWidth(double value)

Sets the border width in points.

If you set line width greater than zero when line style is none, the line style is automatically changed to single line.

Parameters:

value - The border width in points.

isVisible

public boolean isVisible()

Returns true if the LineStyle is not LineStyle.None.

Returns:

True if the LineStyle is not LineStyle.None.

getColor

public java.awt.Color getColor()

Gets the border color.

Returns:

The border color.

setColor

public void setColor(java.awt.Color value)

Sets the border color.

Parameters:

value - The border color.

getDistanceFromText

public double getDistanceFromText()

Gets distance of the border from text or from the page edge in points. Has no effect and will be automatically reset to zero for borders of table cells.

Returns:

Distance of the border from text or from the page edge in points.

See Also:

PageSetup.getBorderDistanceFrom(), PageSetup.setBorderDistanceFrom(int)

setDistanceFromText

public void setDistanceFromText(double value)

Sets distance of the border from text or from the page edge in points. Has no effect and will be automatically reset to zero for borders of table cells.

Parameters:

value - Distance of the border from text or from the page edge in points.

See Also:

PageSetup.getBorderDistanceFrom(), PageSetup.setBorderDistanceFrom(int)

getShadow

public boolean getShadow()

Gets a value indicating whether the border has a shadow.

In Microsoft Word, for a border to have a shadow, the borders on all four sides (left, top, right and bottom) should be of the same type, width, color and all should have the Shadow property set to true.

Returns:

A value indicating whether the border has a shadow.

setShadow

public void setShadow(boolean value)

Sets a value indicating whether the border has a shadow.

In Microsoft Word, for a border to have a shadow, the borders on all four sides (left, top, right and bottom) should be of the same type, width, color and all should have the Shadow property set to true.

Parameters:

value - A value indicating whether the border has a shadow.

equals

public boolean equals(Border rhs)

Determines whether the specified border is equal in value to the current border.

equals

public boolean equals(java.lang.Object obj)

Determines whether the specified object is equal in value to the current object.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isInheritedComplexAttr

public boolean isInheritedComplexAttr()

memberwiseClone

protected java.lang.Object memberwiseClone()