org.zkoss.poi.xssf.usermodel.extensions

Class XSSFCellBorder

java.lang.Object

org.zkoss.poi.xssf.usermodel.extensions.XSSFCellBorder

public class XSSFCellBorder
extends Object

This element contains border formatting information, specifying border definition formats (left, right, top, bottom, diagonal) for cells in the workbook. Color is optional.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XSSFCellBorder.BorderSide The enumeration value indicating the side being used for a cell border.

Constructor Summary

Constructors

Constructor and Description
XSSFCellBorder() Creates a new, empty Cell Border.
XSSFCellBorder(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorder border) Creates a Cell Border from the supplied XML definition
XSSFCellBorder(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorder border, ThemesTable theme) Creates a Cell Border from the supplied XML definition

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
XSSFColor	getBorderColor(XSSFCellBorder.BorderSide side) Get the color to use for the selected border
BorderStyle	getBorderStyle(XSSFCellBorder.BorderSide side) Get the type of border to use for the selected border
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorder	getCTBorder() Returns the underlying XML bean.
int	hashCode()
boolean	isDiagonalDown()
boolean	isDiagonalUp()
void	prepareBorder(short left, Color leftColor, short top, Color topColor, short right, Color rightColor, short bottom, Color bottomColor)
void	setBorderColor(XSSFCellBorder.BorderSide side, XSSFColor color) Set the color to use for the selected border
void	setBorderStyle(XSSFCellBorder.BorderSide side, BorderStyle style) Set the type of border to use for the selected border
void	setBorderStyle(XSSFCellBorder.BorderSide side, int ordinal)
void	setDiagonalDown(boolean down)
void	setDiagonalUp(boolean up)
void	setThemesTable(ThemesTable themes) Records the Themes Table that is associated with the current font, used when looking up theme based colours and properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

XSSFCellBorder

public XSSFCellBorder(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorder border,
                      ThemesTable theme)

Creates a Cell Border from the supplied XML definition

XSSFCellBorder

public XSSFCellBorder(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorder border)

Creates a Cell Border from the supplied XML definition

XSSFCellBorder

public XSSFCellBorder()

Creates a new, empty Cell Border. You need to attach this to the Styles Table

Method Detail

setThemesTable

public void setThemesTable(ThemesTable themes)

Records the Themes Table that is associated with the current font, used when looking up theme based colours and properties.

getCTBorder

@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorder getCTBorder()

Returns the underlying XML bean.

Returns:

CTBorder

getBorderStyle

public BorderStyle getBorderStyle(XSSFCellBorder.BorderSide side)

Get the type of border to use for the selected border

Parameters:

side - - - where to apply the color definition

Returns:

borderstyle - the type of border to use. default value is NONE if border style is not set.

See Also:

BorderStyle

setBorderStyle

public void setBorderStyle(XSSFCellBorder.BorderSide side,
                           BorderStyle style)

Set the type of border to use for the selected border

Parameters:

side - - - where to apply the color definition

style - - border style

See Also:

BorderStyle

setBorderStyle

public void setBorderStyle(XSSFCellBorder.BorderSide side,
                           int ordinal)

getBorderColor

public XSSFColor getBorderColor(XSSFCellBorder.BorderSide side)

Get the color to use for the selected border

Parameters:

side - - where to apply the color definition

Returns:

color - color to use as XSSFColor. null if color is not set

setBorderColor

public void setBorderColor(XSSFCellBorder.BorderSide side,
                           XSSFColor color)

Set the color to use for the selected border

Parameters:

side - - where to apply the color definition

color - - the color to use

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

setDiagonalUp

public void setDiagonalUp(boolean up)

isDiagonalUp

public boolean isDiagonalUp()

setDiagonalDown

public void setDiagonalDown(boolean down)

isDiagonalDown

public boolean isDiagonalDown()

prepareBorder

public void prepareBorder(short left,
                          Color leftColor,
                          short top,
                          Color topColor,
                          short right,
                          Color rightColor,
                          short bottom,
                          Color bottomColor)