Package org.apache.poi.hssf.usermodel
Class HSSFBorderFormatting
java.lang.Object
org.apache.poi.hssf.usermodel.HSSFBorderFormatting
- All Implemented Interfaces:
BorderFormatting
High level representation for Border Formatting component
of Conditional Formatting settings
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
HSSFBorderFormatting
(CFRuleBase cfRuleRecord, HSSFWorkbook workbook) -
Method Summary
Modifier and TypeMethodDescriptionprotected BorderFormatting
HSSF doesn't support table borders, so alwaysBorderStyle.NONE
Deprecated.HSSF doesn't support table borders, so alwaysBorderStyle.NONE
Deprecated.short
short
short
HSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATIC
HSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATIC
short
short
short
short
HSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATIC
HSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATIC
boolean
boolean
void
setBackwardDiagonalOn
(boolean on) void
setBorderBottom
(BorderStyle border) Set bottom border.void
setBorderDiagonal
(BorderStyle border) Set diagonal border.void
setBorderHorizontal
(BorderStyle border) Not available for HSSF.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) Not available for HSSF.void
setBottomBorderColor
(short color) void
setBottomBorderColor
(Color color) void
setDiagonalBorderColor
(short color) void
setDiagonalBorderColor
(Color color) void
setForwardDiagonalOn
(boolean on) void
setHorizontalBorderColor
(short color) Not available for HSSF.void
setHorizontalBorderColor
(Color color) Not available for HSSF.void
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) Not available for HSSF.void
setVerticalBorderColor
(Color color) Not available for HSSF.
-
Constructor Details
-
HSSFBorderFormatting
-
-
Method Details
-
getBorderFormattingBlock
-
getBorderBottom
- Specified by:
getBorderBottom
in interfaceBorderFormatting
-
getBorderDiagonal
- Specified by:
getBorderDiagonal
in interfaceBorderFormatting
-
getBorderLeft
- Specified by:
getBorderLeft
in interfaceBorderFormatting
-
getBorderRight
- Specified by:
getBorderRight
in interfaceBorderFormatting
-
getBorderTop
- Specified by:
getBorderTop
in interfaceBorderFormatting
-
getBottomBorderColor
public short getBottomBorderColor()- Specified by:
getBottomBorderColor
in interfaceBorderFormatting
-
getBottomBorderColorColor
- Specified by:
getBottomBorderColorColor
in interfaceBorderFormatting
-
getDiagonalBorderColor
public short getDiagonalBorderColor()- Specified by:
getDiagonalBorderColor
in interfaceBorderFormatting
-
getDiagonalBorderColorColor
- Specified by:
getDiagonalBorderColorColor
in interfaceBorderFormatting
-
getLeftBorderColor
public short getLeftBorderColor()- Specified by:
getLeftBorderColor
in interfaceBorderFormatting
-
getLeftBorderColorColor
- Specified by:
getLeftBorderColorColor
in interfaceBorderFormatting
-
getRightBorderColor
public short getRightBorderColor()- Specified by:
getRightBorderColor
in interfaceBorderFormatting
-
getRightBorderColorColor
- Specified by:
getRightBorderColorColor
in interfaceBorderFormatting
-
getTopBorderColor
public short getTopBorderColor()- Specified by:
getTopBorderColor
in interfaceBorderFormatting
-
getTopBorderColorColor
- Specified by:
getTopBorderColorColor
in interfaceBorderFormatting
-
isBackwardDiagonalOn
public boolean isBackwardDiagonalOn() -
isForwardDiagonalOn
public boolean isForwardDiagonalOn() -
setBackwardDiagonalOn
public void setBackwardDiagonalOn(boolean on) -
setForwardDiagonalOn
public void setForwardDiagonalOn(boolean on) -
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
public void setBottomBorderColor(short color) - Specified by:
setBottomBorderColor
in interfaceBorderFormatting
-
setBottomBorderColor
- Specified by:
setBottomBorderColor
in interfaceBorderFormatting
-
setDiagonalBorderColor
public void setDiagonalBorderColor(short color) - Specified by:
setDiagonalBorderColor
in interfaceBorderFormatting
-
setDiagonalBorderColor
- Specified by:
setDiagonalBorderColor
in interfaceBorderFormatting
-
setLeftBorderColor
public void setLeftBorderColor(short color) - Specified by:
setLeftBorderColor
in interfaceBorderFormatting
-
setLeftBorderColor
- Specified by:
setLeftBorderColor
in interfaceBorderFormatting
-
setRightBorderColor
public void setRightBorderColor(short color) - Specified by:
setRightBorderColor
in interfaceBorderFormatting
-
setRightBorderColor
- Specified by:
setRightBorderColor
in interfaceBorderFormatting
-
setTopBorderColor
public void setTopBorderColor(short color) - Specified by:
setTopBorderColor
in interfaceBorderFormatting
-
setTopBorderColor
- Specified by:
setTopBorderColor
in interfaceBorderFormatting
-
getBorderVertical
HSSF doesn't support table borders, so alwaysBorderStyle.NONE
- Specified by:
getBorderVertical
in interfaceBorderFormatting
- Returns:
- border style
- See Also:
-
getBorderHorizontal
HSSF doesn't support table borders, so alwaysBorderStyle.NONE
- Specified by:
getBorderHorizontal
in interfaceBorderFormatting
- Returns:
- border style
- See Also:
-
getBorderBottomEnum
- Specified by:
getBorderBottomEnum
in interfaceBorderFormatting
-
getBorderDiagonalEnum
- Specified by:
getBorderDiagonalEnum
in interfaceBorderFormatting
-
getBorderLeftEnum
- Specified by:
getBorderLeftEnum
in interfaceBorderFormatting
-
getBorderRightEnum
- Specified by:
getBorderRightEnum
in interfaceBorderFormatting
-
getBorderTopEnum
- Specified by:
getBorderTopEnum
in interfaceBorderFormatting
-
getBorderVerticalEnum
Deprecated.HSSF doesn't support table borders, so alwaysBorderStyle.NONE
- Specified by:
getBorderVerticalEnum
in interfaceBorderFormatting
- Returns:
- border style
- See Also:
-
getBorderHorizontalEnum
Deprecated.HSSF doesn't support table borders, so alwaysBorderStyle.NONE
- Specified by:
getBorderHorizontalEnum
in interfaceBorderFormatting
- Returns:
- border style
- See Also:
-
getVerticalBorderColor
public short getVerticalBorderColor()HSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATIC
- Specified by:
getVerticalBorderColor
in interfaceBorderFormatting
- Returns:
- color index
- See Also:
-
getVerticalBorderColorColor
HSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATIC
- Specified by:
getVerticalBorderColorColor
in interfaceBorderFormatting
- Returns:
- color
- See Also:
-
getHorizontalBorderColor
public short getHorizontalBorderColor()HSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATIC
- Specified by:
getHorizontalBorderColor
in interfaceBorderFormatting
- Returns:
- color index
- See Also:
-
getHorizontalBorderColorColor
HSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATIC
- Specified by:
getHorizontalBorderColorColor
in interfaceBorderFormatting
- Returns:
- color
- See Also:
-
setBorderHorizontal
Not available for HSSF.- Specified by:
setBorderHorizontal
in interfaceBorderFormatting
- Parameters:
border
- The style of border to set.- See Also:
-
setBorderVertical
Not available for HSSF.- Specified by:
setBorderVertical
in interfaceBorderFormatting
- Parameters:
border
- The style of border to set.- See Also:
-
setHorizontalBorderColor
public void setHorizontalBorderColor(short color) Not available for HSSF.- Specified by:
setHorizontalBorderColor
in interfaceBorderFormatting
- Parameters:
color
- index- See Also:
-
setHorizontalBorderColor
Not available for HSSF.- Specified by:
setHorizontalBorderColor
in interfaceBorderFormatting
- Parameters:
color
- index- See Also:
-
setVerticalBorderColor
public void setVerticalBorderColor(short color) Not available for HSSF.- Specified by:
setVerticalBorderColor
in interfaceBorderFormatting
- Parameters:
color
- index- See Also:
-
setVerticalBorderColor
Not available for HSSF.- Specified by:
setVerticalBorderColor
in interfaceBorderFormatting
- Parameters:
color
- index- See Also:
-