com.spire.doc.documents
Class Borders

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.formatting.FormatBase
              com.spire.doc.formatting.AttrCollection
                  com.spire.doc.formatting.WordAttrCollection
                      com.spire.doc.documents.Borders

public class Borders
extends WordAttrCollection

Represents a collection of four borders. Border

Field Summary

static int	Bottom_Key Constant value for bottom key.
static int	Diagonal_Down_Key constant value for diagonal down key.
static int	Diagonal_Up_Key constant value for diagonal up key.
static int	Horizontal_Key constant value for horizontal key.
static int	Left_Key Constant value for left key.
static int	Right_Key Constant value for right key.
static int	Top_Key Constant value for top key.
static int	Vertical_Key constant value for vertical key.

Constructor Summary

Borders()
Initializes a new instance of the Border class.

Method Summary

Borders	deepClone() Clones self.
Border	getBottom() Gets bottom border.
Border	getHorizontal() Gets horizontal border.
Border	getLeft() Gets left border.
boolean	getNoBorder() Gets whether the border exists
Border	getRight() Gets right border.
Border	getTop() Gets top border.
Border	getVertical() Gets vertical border.
boolean	isDefault() Gets a value indicating whether format is default.
void	isShadow(boolean value) Sets whether borders are drawn with shadow.
void	setBorderType(BorderStyle value) Sets style of the borders.
void	setColor(java.awt.Color value) Sets color of the borders.
void	setLineWidth(float value) Sets width of the borders.
void	setSpace(float value) Sets width of space to maintain between borders and text within borders.

Methods inherited from class com.spire.doc.formatting.FormatBase

clearFormatting, hasKey

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Field Detail

Left_Key

public static final int Left_Key

Constant value for left key.

See Also:

Constant Field Values

Top_Key

public static final int Top_Key

Constant value for top key.

See Also:

Constant Field Values

Bottom_Key

public static final int Bottom_Key

Constant value for bottom key.

See Also:

Constant Field Values

Right_Key

public static final int Right_Key

Constant value for right key.

See Also:

Constant Field Values

Vertical_Key

public static final int Vertical_Key

constant value for vertical key.

See Also:

Constant Field Values

Horizontal_Key

public static final int Horizontal_Key

constant value for horizontal key.

See Also:

Constant Field Values

Diagonal_Down_Key

public static final int Diagonal_Down_Key

constant value for diagonal down key.

See Also:

Constant Field Values

Diagonal_Up_Key

public static final int Diagonal_Up_Key

constant value for diagonal up key.

See Also:

Constant Field Values

Constructor Detail

Borders

public Borders()

Initializes a new instance of the Border class.

Method Detail

getNoBorder

public boolean getNoBorder()

Gets whether the border exists

Returns:

boolean

getLeft

public Border getLeft()

Gets left border.

Returns:

border object

getTop

public Border getTop()

Gets top border.

Returns:

Border object

getRight

public Border getRight()

Gets right border.

Returns:

Border object

getBottom

public Border getBottom()

Gets bottom border.

Returns:

Border object

getVertical

public Border getVertical()

Gets vertical border.

Returns:

Border object

getHorizontal

public Border getHorizontal()

Gets horizontal border.

Returns:

Border object

setColor

public void setColor(java.awt.Color value)

Sets color of the borders.

Parameters:

value - color

setLineWidth

public void setLineWidth(float value)

Sets width of the borders.

setBorderType

public void setBorderType(BorderStyle value)

Sets style of the borders.

Parameters:

value - borderStyle

setSpace

public void setSpace(float value)

Sets width of space to maintain between borders and text within borders.

Parameters:

value - float

isShadow

public void isShadow(boolean value)

Sets whether borders are drawn with shadow.

Parameters:

value - boolean

isDefault

public boolean isDefault()

Gets a value indicating whether format is default.

Overrides:

isDefault in class FormatBase

Returns:

boolean

deepClone

public Borders deepClone()

Clones self.

Overrides:

deepClone in class AttrCollection

Returns:

Borders