Package org.apache.poi.xssf.usermodel
Class XSSFBorderFormatting
java.lang.Object
org.apache.poi.xssf.usermodel.XSSFBorderFormatting
- All Implemented Interfaces:
BorderFormatting
XSSF high level representation for Border Formatting component
of Conditional Formatting settings
-
Method Summary
Modifier and TypeMethodDescriptionOnly valid for range borders, such as table stylesOnly valid for range borders, such as table stylesOnly valid for range borders, such as table stylesOnly valid for range borders, such as table stylesshort
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
setBottomBorderColor
(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) void
setDiagonalBorderColor
(short color) void
setDiagonalBorderColor
(Color color) void
setDiagonalBorderColor
(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) void
setHorizontalBorderColor
(short color) Range internal border color, such as table stylesvoid
setHorizontalBorderColor
(Color color) Range internal border color, such as table stylesvoid
setHorizontalBorderColor
(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) void
setLeftBorderColor
(short color) void
setLeftBorderColor
(Color color) void
setLeftBorderColor
(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) void
setRightBorderColor
(short color) void
setRightBorderColor
(Color color) void
setRightBorderColor
(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) void
setTopBorderColor
(short color) void
setTopBorderColor
(Color color) void
setTopBorderColor
(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) void
setVerticalBorderColor
(short color) Range internal border color, such as table stylesvoid
setVerticalBorderColor
(Color color) Range internal border color, such as table stylesvoid
setVerticalBorderColor
(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)
-
Method Details
-
getBorderBottom
- Specified by:
getBorderBottom
in interfaceBorderFormatting
-
getBorderDiagonal
- Specified by:
getBorderDiagonal
in interfaceBorderFormatting
-
getBorderLeft
- Specified by:
getBorderLeft
in interfaceBorderFormatting
-
getBorderRight
- Specified by:
getBorderRight
in interfaceBorderFormatting
-
getBorderTopEnum
- Specified by:
getBorderTopEnum
in interfaceBorderFormatting
-
getBorderBottomEnum
- Specified by:
getBorderBottomEnum
in interfaceBorderFormatting
-
getBorderDiagonalEnum
- Specified by:
getBorderDiagonalEnum
in interfaceBorderFormatting
-
getBorderLeftEnum
- Specified by:
getBorderLeftEnum
in interfaceBorderFormatting
-
getBorderRightEnum
- Specified by:
getBorderRightEnum
in interfaceBorderFormatting
-
getBorderTop
- Specified by:
getBorderTop
in interfaceBorderFormatting
-
getBottomBorderColorColor
- Specified by:
getBottomBorderColorColor
in interfaceBorderFormatting
-
getBottomBorderColor
public short getBottomBorderColor()- Specified by:
getBottomBorderColor
in interfaceBorderFormatting
-
getDiagonalBorderColorColor
- Specified by:
getDiagonalBorderColorColor
in interfaceBorderFormatting
-
getDiagonalBorderColor
public short getDiagonalBorderColor()- Specified by:
getDiagonalBorderColor
in interfaceBorderFormatting
-
getLeftBorderColorColor
- Specified by:
getLeftBorderColorColor
in interfaceBorderFormatting
-
getLeftBorderColor
public short getLeftBorderColor()- Specified by:
getLeftBorderColor
in interfaceBorderFormatting
-
getRightBorderColorColor
- Specified by:
getRightBorderColorColor
in interfaceBorderFormatting
-
getRightBorderColor
public short getRightBorderColor()- Specified by:
getRightBorderColor
in interfaceBorderFormatting
-
getTopBorderColorColor
- Specified by:
getTopBorderColorColor
in interfaceBorderFormatting
-
getTopBorderColor
public short getTopBorderColor()- Specified by:
getTopBorderColor
in interfaceBorderFormatting
-
setBorderBottom
Description copied from interface:BorderFormatting
Set bottom border.- Specified by:
setBorderBottom
in interfaceBorderFormatting
- Parameters:
border
- The style of border to set.
-
setBorderDiagonal
Description copied from interface:BorderFormatting
Set diagonal border.- Specified by:
setBorderDiagonal
in interfaceBorderFormatting
- Parameters:
border
- The style of border to set.
-
setBorderLeft
Description copied from interface:BorderFormatting
Set left border.- Specified by:
setBorderLeft
in interfaceBorderFormatting
- Parameters:
border
- The style of border to set.
-
setBorderRight
Description copied from interface:BorderFormatting
Set right border.- Specified by:
setBorderRight
in interfaceBorderFormatting
- Parameters:
border
- The style of border to set.
-
setBorderTop
Description copied from interface:BorderFormatting
Set top border.- Specified by:
setBorderTop
in interfaceBorderFormatting
- Parameters:
border
- The style of border to set.
-
setBottomBorderColor
- Specified by:
setBottomBorderColor
in interfaceBorderFormatting
-
setBottomBorderColor
public void setBottomBorderColor(short color) - Specified by:
setBottomBorderColor
in interfaceBorderFormatting
-
setBottomBorderColor
public void setBottomBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) -
setDiagonalBorderColor
- Specified by:
setDiagonalBorderColor
in interfaceBorderFormatting
-
setDiagonalBorderColor
public void setDiagonalBorderColor(short color) - Specified by:
setDiagonalBorderColor
in interfaceBorderFormatting
-
setDiagonalBorderColor
public void setDiagonalBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) -
setLeftBorderColor
- Specified by:
setLeftBorderColor
in interfaceBorderFormatting
-
setLeftBorderColor
public void setLeftBorderColor(short color) - Specified by:
setLeftBorderColor
in interfaceBorderFormatting
-
setLeftBorderColor
public void setLeftBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) -
setRightBorderColor
- Specified by:
setRightBorderColor
in interfaceBorderFormatting
-
setRightBorderColor
public void setRightBorderColor(short color) - Specified by:
setRightBorderColor
in interfaceBorderFormatting
-
setRightBorderColor
public void setRightBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) -
setTopBorderColor
- Specified by:
setTopBorderColor
in interfaceBorderFormatting
-
setTopBorderColor
public void setTopBorderColor(short color) - Specified by:
setTopBorderColor
in interfaceBorderFormatting
-
setTopBorderColor
public void setTopBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) -
getBorderVertical
Description copied from interface:BorderFormatting
Only valid for range borders, such as table styles- Specified by:
getBorderVertical
in interfaceBorderFormatting
- Returns:
- border style
-
getBorderHorizontal
Description copied from interface:BorderFormatting
Only valid for range borders, such as table styles- Specified by:
getBorderHorizontal
in interfaceBorderFormatting
- Returns:
- border style
-
getBorderVerticalEnum
Description copied from interface:BorderFormatting
Only valid for range borders, such as table styles- Specified by:
getBorderVerticalEnum
in interfaceBorderFormatting
- Returns:
- border style
-
getBorderHorizontalEnum
Description copied from interface:BorderFormatting
Only valid for range borders, such as table styles- Specified by:
getBorderHorizontalEnum
in interfaceBorderFormatting
- Returns:
- border style
-
getVerticalBorderColor
public short getVerticalBorderColor()Description copied from interface:BorderFormatting
Range internal borders. Only relevant for range styles, such as table formatting- Specified by:
getVerticalBorderColor
in interfaceBorderFormatting
- Returns:
- color index
-
getVerticalBorderColorColor
Description copied from interface:BorderFormatting
Range internal borders. Only relevant for range styles, such as table formatting- Specified by:
getVerticalBorderColorColor
in interfaceBorderFormatting
- Returns:
- color
-
getHorizontalBorderColor
public short getHorizontalBorderColor()Description copied from interface:BorderFormatting
Range internal borders. Only relevant for range styles, such as table formatting- Specified by:
getHorizontalBorderColor
in interfaceBorderFormatting
- Returns:
- color index
-
getHorizontalBorderColorColor
Description copied from interface:BorderFormatting
Range internal borders. Only relevant for range styles, such as table formatting- Specified by:
getHorizontalBorderColorColor
in interfaceBorderFormatting
- Returns:
- color
-
setBorderHorizontal
Description copied from interface:BorderFormatting
Set range internal horizontal borders.- Specified by:
setBorderHorizontal
in interfaceBorderFormatting
- Parameters:
border
- The style of border to set.
-
setBorderVertical
Description copied from interface:BorderFormatting
Set range internal vertical borders.- Specified by:
setBorderVertical
in interfaceBorderFormatting
- Parameters:
border
- The style of border to set.
-
setHorizontalBorderColor
public void setHorizontalBorderColor(short color) Description copied from interface:BorderFormatting
Range internal border color, such as table styles- Specified by:
setHorizontalBorderColor
in interfaceBorderFormatting
- Parameters:
color
- index
-
setHorizontalBorderColor
Description copied from interface:BorderFormatting
Range internal border color, such as table styles- Specified by:
setHorizontalBorderColor
in interfaceBorderFormatting
- Parameters:
color
- index
-
setHorizontalBorderColor
public void setHorizontalBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) -
setVerticalBorderColor
public void setVerticalBorderColor(short color) Description copied from interface:BorderFormatting
Range internal border color, such as table styles- Specified by:
setVerticalBorderColor
in interfaceBorderFormatting
- Parameters:
color
- index
-
setVerticalBorderColor
Description copied from interface:BorderFormatting
Range internal border color, such as table styles- Specified by:
setVerticalBorderColor
in interfaceBorderFormatting
- Parameters:
color
- index
-
setVerticalBorderColor
public void setVerticalBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)
-