Package org.apache.poi.ss.usermodel
Interface BorderFormatting
- All Known Implementing Classes:
HSSFBorderFormatting,XSSFBorderFormatting
public interface BorderFormatting
High level representation for Border Formatting component
of Conditional Formatting settings
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Deprecated.usegetBorderDiagonalinsteadOnly valid for range borders, such as table stylesDeprecated.usegetBorderHorizontalinsteadDeprecated.usegetBorderLeftinsteadDeprecated.usegetBorderRightinsteadDeprecated.usegetBorderTopinsteadOnly valid for range borders, such as table stylesDeprecated.usegetBorderVerticalinsteadshortshortshortRange internal borders.Range internal borders.shortshortshortshortRange internal borders.Range internal borders.voidsetBorderBottom(BorderStyle border) Set bottom border.voidsetBorderDiagonal(BorderStyle border) Set diagonal border.voidsetBorderHorizontal(BorderStyle border) Set range internal horizontal borders.voidsetBorderLeft(BorderStyle border) Set left border.voidsetBorderRight(BorderStyle border) Set right border.voidsetBorderTop(BorderStyle border) Set top border.voidsetBorderVertical(BorderStyle border) Set range internal vertical borders.voidsetBottomBorderColor(short color) voidsetBottomBorderColor(Color color) voidsetDiagonalBorderColor(short color) voidsetDiagonalBorderColor(Color color) voidsetHorizontalBorderColor(short color) Range internal border color, such as table stylesvoidsetHorizontalBorderColor(Color color) Range internal border color, such as table stylesvoidsetLeftBorderColor(short color) voidsetLeftBorderColor(Color color) voidsetRightBorderColor(short color) voidsetRightBorderColor(Color color) voidsetTopBorderColor(short color) voidsetTopBorderColor(Color color) voidsetVerticalBorderColor(short color) Range internal border color, such as table stylesvoidsetVerticalBorderColor(Color color) Range internal border color, such as table styles
-
Method Details
-
getBorderBottom
BorderStyle getBorderBottom()- Since:
- POI 4.0.0
-
getBorderDiagonal
BorderStyle getBorderDiagonal()- Since:
- POI 4.0.0
-
getBorderLeft
BorderStyle getBorderLeft()- Since:
- POI 4.0.0
-
getBorderRight
BorderStyle getBorderRight()- Since:
- POI 4.0.0
-
getBorderTop
BorderStyle getBorderTop()- Since:
- POI 4.0.0
-
getBorderVertical
BorderStyle getBorderVertical()Only valid for range borders, such as table styles- Returns:
- border style
- Since:
- 4.0.0
-
getBorderHorizontal
BorderStyle getBorderHorizontal()Only valid for range borders, such as table styles- Returns:
- border style
- Since:
- 4.0.0
-
getBorderBottomEnum
Deprecated.usegetBorderBottominstead- Since:
- POI 3.15
-
getBorderDiagonalEnum
Deprecated.usegetBorderDiagonalinstead- Since:
- POI 3.15
-
getBorderLeftEnum
Deprecated.usegetBorderLeftinstead- Since:
- POI 3.15
-
getBorderRightEnum
Deprecated.usegetBorderRightinstead- Since:
- POI 3.15
-
getBorderTopEnum
Deprecated.usegetBorderTopinstead- Since:
- POI 3.15
-
getBorderVerticalEnum
Deprecated.usegetBorderVerticalinsteadOnly valid for range borders, such as table styles- Returns:
- border style
- Since:
- 3.17 beta 1
-
getBorderHorizontalEnum
Deprecated.usegetBorderHorizontalinsteadOnly 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
Set bottom border.- Parameters:
border- The style of border to set.
-
setBorderDiagonal
Set diagonal border.- Parameters:
border- The style of border to set.
-
setBorderLeft
Set left border.- Parameters:
border- The style of border to set.
-
setBorderRight
Set right border.- Parameters:
border- The style of border to set.
-
setBorderTop
Set top border.- Parameters:
border- The style of border to set.
-
setBorderHorizontal
Set range internal horizontal borders.- Parameters:
border- The style of border to set.- Since:
- 3.17 beta 1
-
setBorderVertical
Set range internal vertical borders.- Parameters:
border- The style of border to set.- Since:
- 3.17 beta 1
-
setBottomBorderColor
void setBottomBorderColor(short color) -
setBottomBorderColor
-
setDiagonalBorderColor
void setDiagonalBorderColor(short color) -
setDiagonalBorderColor
-
setLeftBorderColor
void setLeftBorderColor(short color) -
setLeftBorderColor
-
setRightBorderColor
void setRightBorderColor(short color) -
setRightBorderColor
-
setTopBorderColor
void setTopBorderColor(short color) -
setTopBorderColor
-
setHorizontalBorderColor
void setHorizontalBorderColor(short color) Range internal border color, such as table styles- Parameters:
color- index- Since:
- 3.17 beta 1
-
setHorizontalBorderColor
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
Range internal border color, such as table styles- Parameters:
color- index- Since:
- 3.17 beta 1
-
getBorderBottominstead