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.usegetBorderDiagonal
insteadOnly valid for range borders, such as table stylesDeprecated.usegetBorderHorizontal
insteadDeprecated.usegetBorderLeft
insteadDeprecated.usegetBorderRight
insteadDeprecated.usegetBorderTop
insteadOnly valid for range borders, such as table stylesDeprecated.usegetBorderVertical
insteadshort
short
short
Range internal borders.Range internal borders.short
short
short
short
Range internal borders.Range internal borders.void
setBorderBottom
(BorderStyle border) Set bottom border.void
setBorderDiagonal
(BorderStyle border) Set diagonal border.void
setBorderHorizontal
(BorderStyle border) Set range internal horizontal borders.void
setBorderLeft
(BorderStyle border) Set left border.void
setBorderRight
(BorderStyle border) Set right border.void
setBorderTop
(BorderStyle border) Set top border.void
setBorderVertical
(BorderStyle border) Set range internal vertical borders.void
setBottomBorderColor
(short color) void
setBottomBorderColor
(Color color) void
setDiagonalBorderColor
(short color) void
setDiagonalBorderColor
(Color color) void
setHorizontalBorderColor
(short color) Range internal border color, such as table stylesvoid
setHorizontalBorderColor
(Color color) Range internal border color, such as table stylesvoid
setLeftBorderColor
(short color) void
setLeftBorderColor
(Color color) void
setRightBorderColor
(short color) void
setRightBorderColor
(Color color) void
setTopBorderColor
(short color) void
setTopBorderColor
(Color color) void
setVerticalBorderColor
(short color) Range internal border color, such as table stylesvoid
setVerticalBorderColor
(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.usegetBorderBottom
instead- Since:
- POI 3.15
-
getBorderDiagonalEnum
Deprecated.usegetBorderDiagonal
instead- Since:
- POI 3.15
-
getBorderLeftEnum
Deprecated.usegetBorderLeft
instead- Since:
- POI 3.15
-
getBorderRightEnum
Deprecated.usegetBorderRight
instead- Since:
- POI 3.15
-
getBorderTopEnum
Deprecated.usegetBorderTop
instead- Since:
- POI 3.15
-
getBorderVerticalEnum
Deprecated.usegetBorderVertical
insteadOnly valid for range borders, such as table styles- Returns:
- border style
- Since:
- 3.17 beta 1
-
getBorderHorizontalEnum
Deprecated.usegetBorderHorizontal
insteadOnly 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
-
getBorderBottom
instead