org.apache.poi.ss.usermodel
Interface BorderFormatting

All Known Implementing Classes:

HSSFBorderFormatting

public interface BorderFormatting

High level representation for Border Formatting component of Conditional Formatting settings

getBorderBottom

short getBorderBottom()

Deprecated. POI 3.15. Use getBorderBottomEnum(). This method will return an BorderStyle enum in the future.

getBorderBottomEnum

BorderStyle getBorderBottomEnum()

Since:

POI 3.15

getBorderDiagonal

short getBorderDiagonal()

Deprecated. POI 3.15. Use getBorderDiagonalEnum(). This method will return an BorderStyle enum in the future.

getBorderDiagonalEnum

BorderStyle getBorderDiagonalEnum()

Since:

POI 3.15

getBorderLeft

short getBorderLeft()

Deprecated. POI 3.15. Use getBorderLeftEnum(). This method will return an BorderStyle enum in the future.

getBorderLeftEnum

BorderStyle getBorderLeftEnum()

Since:

POI 3.15

getBorderRight

short getBorderRight()

Deprecated. POI 3.15. Use getBorderRightEnum(). This method will return an BorderStyle enum in the future.

getBorderRightEnum

BorderStyle getBorderRightEnum()

Since:

POI 3.15

getBorderTop

short getBorderTop()

Deprecated. POI 3.15. Use getBorderTopEnum(). This method will return an BorderStyle enum in the future.

getBorderTopEnum

BorderStyle getBorderTopEnum()

Since:

POI 3.15

getBorderVerticalEnum

BorderStyle getBorderVerticalEnum()

Only valid for range borders, such as table styles

Returns:

border style

Since:

3.17 beta 1

getBorderHorizontalEnum

BorderStyle getBorderHorizontalEnum()

Only valid for range borders, such as table styles

Returns:

border style

Since:

3.17 beta 1

getBottomBorderColor

short getBottomBorderColor()

getBottomBorderColorColor

Color getBottomBorderColorColor()

getDiagonalBorderColor

short getDiagonalBorderColor()

getDiagonalBorderColorColor

Color getDiagonalBorderColorColor()

getLeftBorderColor

short getLeftBorderColor()

getLeftBorderColorColor

Color getLeftBorderColorColor()

getRightBorderColor

short getRightBorderColor()

getRightBorderColorColor

Color getRightBorderColorColor()

getTopBorderColor

short getTopBorderColor()

getTopBorderColorColor

Color getTopBorderColorColor()

getVerticalBorderColor

short getVerticalBorderColor()

Range internal borders. Only relevant for range styles, such as table formatting

Returns:

color index

Since:

3.17 beta 1

getVerticalBorderColorColor

Color getVerticalBorderColorColor()

Range internal borders. Only relevant for range styles, such as table formatting

Returns:

color

Since:

3.17 beta 1

getHorizontalBorderColor

short getHorizontalBorderColor()

Range internal borders. Only relevant for range styles, such as table formatting

Returns:

color index

Since:

3.17 beta 1

getHorizontalBorderColorColor

Color getHorizontalBorderColorColor()

Range internal borders. Only relevant for range styles, such as table formatting

Returns:

color

Since:

3.17 beta 1

setBorderBottom

void setBorderBottom(short border)

Deprecated. 3.15 beta 2. Use setBorderBottom(BorderStyle)

Set bottom border.

Parameters:

border - MUST be a BORDER_* constant

setBorderBottom

void setBorderBottom(BorderStyle border)

Set bottom border.

Parameters:

border -

setBorderDiagonal

void setBorderDiagonal(short border)

Deprecated. 3.15 beta 2. Use setBorderDiagonal(BorderStyle)

Set diagonal border.

Parameters:

border - MUST be a BORDER_* constant

setBorderDiagonal

void setBorderDiagonal(BorderStyle border)

Set diagonal border.

Parameters:

border -

setBorderLeft

void setBorderLeft(short border)

Deprecated. 3.15 beta 2. Use setBorderLeft(BorderStyle)

Set left border.

Parameters:

border - MUST be a BORDER_* constant

setBorderLeft

void setBorderLeft(BorderStyle border)

Set left border.

Parameters:

border -

setBorderRight

void setBorderRight(short border)

Deprecated. 3.15 beta 2. Use setBorderRight(BorderStyle)

Set right border.

Parameters:

border - MUST be a BORDER_* constant

setBorderRight

void setBorderRight(BorderStyle border)

Set right border.

Parameters:

border -

setBorderTop

void setBorderTop(short border)

Deprecated. 3.15 beta 2. Use setBorderTop(BorderStyle)

Set top border.

Parameters:

border - MUST be a BORDER_* constant

setBorderTop

void setBorderTop(BorderStyle border)

Set top border.

Parameters:

border -

setBorderHorizontal

void setBorderHorizontal(BorderStyle border)

Set range internal horizontal borders.

Parameters:

border -

Since:

3.17 beta 1

setBorderVertical

void setBorderVertical(BorderStyle border)

Set range internal vertical borders.

Parameters:

border -

Since:

3.17 beta 1

setBottomBorderColor

void setBottomBorderColor(short color)

setBottomBorderColor

void setBottomBorderColor(Color color)

setDiagonalBorderColor

void setDiagonalBorderColor(short color)

setDiagonalBorderColor

void setDiagonalBorderColor(Color color)

setLeftBorderColor

void setLeftBorderColor(short color)

setLeftBorderColor

void setLeftBorderColor(Color color)

setRightBorderColor

void setRightBorderColor(short color)

setRightBorderColor

void setRightBorderColor(Color color)

setTopBorderColor

void setTopBorderColor(short color)

setTopBorderColor

void setTopBorderColor(Color color)

setHorizontalBorderColor

void setHorizontalBorderColor(short color)

Range internal border color, such as table styles

Parameters:

color - index

Since:

3.17 beta 1

setHorizontalBorderColor

void setHorizontalBorderColor(Color color)

Range internal border color, such as table styles

Parameters:

color - index

Since:

3.17 beta 1

setVerticalBorderColor

void setVerticalBorderColor(short color)

Range internal border color, such as table styles

Parameters:

color - index

Since:

3.17 beta 1

setVerticalBorderColor

void setVerticalBorderColor(Color color)

Range internal border color, such as table styles

Parameters:

color - index

Since:

3.17 beta 1