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
ConstructorsModifierConstructorDescriptionprotectedHSSFBorderFormatting(CFRuleBase cfRuleRecord, HSSFWorkbook workbook) -
Method Summary
Modifier and TypeMethodDescriptionprotected BorderFormattingHSSF doesn't support table borders, so alwaysBorderStyle.NONEDeprecated.HSSF doesn't support table borders, so alwaysBorderStyle.NONEDeprecated.shortshortshortHSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATICHSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATICshortshortshortshortHSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATICHSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATICbooleanbooleanvoidsetBackwardDiagonalOn(boolean on) voidsetBorderBottom(BorderStyle border) Set bottom border.voidsetBorderDiagonal(BorderStyle border) Set diagonal border.voidsetBorderHorizontal(BorderStyle border) Not available for HSSF.voidsetBorderLeft(BorderStyle border) Set left border.voidsetBorderRight(BorderStyle border) Set right border.voidsetBorderTop(BorderStyle border) Set top border.voidsetBorderVertical(BorderStyle border) Not available for HSSF.voidsetBottomBorderColor(short color) voidsetBottomBorderColor(Color color) voidsetDiagonalBorderColor(short color) voidsetDiagonalBorderColor(Color color) voidsetForwardDiagonalOn(boolean on) voidsetHorizontalBorderColor(short color) Not available for HSSF.voidsetHorizontalBorderColor(Color color) Not available for HSSF.voidsetLeftBorderColor(short color) voidsetLeftBorderColor(Color color) voidsetRightBorderColor(short color) voidsetRightBorderColor(Color color) voidsetTopBorderColor(short color) voidsetTopBorderColor(Color color) voidsetVerticalBorderColor(short color) Not available for HSSF.voidsetVerticalBorderColor(Color color) Not available for HSSF.
-
Constructor Details
-
HSSFBorderFormatting
-
-
Method Details
-
getBorderFormattingBlock
-
getBorderBottom
- Specified by:
getBorderBottomin interfaceBorderFormatting
-
getBorderDiagonal
- Specified by:
getBorderDiagonalin interfaceBorderFormatting
-
getBorderLeft
- Specified by:
getBorderLeftin interfaceBorderFormatting
-
getBorderRight
- Specified by:
getBorderRightin interfaceBorderFormatting
-
getBorderTop
- Specified by:
getBorderTopin interfaceBorderFormatting
-
getBottomBorderColor
public short getBottomBorderColor()- Specified by:
getBottomBorderColorin interfaceBorderFormatting
-
getBottomBorderColorColor
- Specified by:
getBottomBorderColorColorin interfaceBorderFormatting
-
getDiagonalBorderColor
public short getDiagonalBorderColor()- Specified by:
getDiagonalBorderColorin interfaceBorderFormatting
-
getDiagonalBorderColorColor
- Specified by:
getDiagonalBorderColorColorin interfaceBorderFormatting
-
getLeftBorderColor
public short getLeftBorderColor()- Specified by:
getLeftBorderColorin interfaceBorderFormatting
-
getLeftBorderColorColor
- Specified by:
getLeftBorderColorColorin interfaceBorderFormatting
-
getRightBorderColor
public short getRightBorderColor()- Specified by:
getRightBorderColorin interfaceBorderFormatting
-
getRightBorderColorColor
- Specified by:
getRightBorderColorColorin interfaceBorderFormatting
-
getTopBorderColor
public short getTopBorderColor()- Specified by:
getTopBorderColorin interfaceBorderFormatting
-
getTopBorderColorColor
- Specified by:
getTopBorderColorColorin 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:BorderFormattingSet bottom border.- Specified by:
setBorderBottomin interfaceBorderFormatting- Parameters:
border- The style of border to set.
-
setBorderDiagonal
Description copied from interface:BorderFormattingSet diagonal border.- Specified by:
setBorderDiagonalin interfaceBorderFormatting- Parameters:
border- The style of border to set.
-
setBorderLeft
Description copied from interface:BorderFormattingSet left border.- Specified by:
setBorderLeftin interfaceBorderFormatting- Parameters:
border- The style of border to set.
-
setBorderRight
Description copied from interface:BorderFormattingSet right border.- Specified by:
setBorderRightin interfaceBorderFormatting- Parameters:
border- The style of border to set.
-
setBorderTop
Description copied from interface:BorderFormattingSet top border.- Specified by:
setBorderTopin interfaceBorderFormatting- Parameters:
border- The style of border to set.
-
setBottomBorderColor
public void setBottomBorderColor(short color) - Specified by:
setBottomBorderColorin interfaceBorderFormatting
-
setBottomBorderColor
- Specified by:
setBottomBorderColorin interfaceBorderFormatting
-
setDiagonalBorderColor
public void setDiagonalBorderColor(short color) - Specified by:
setDiagonalBorderColorin interfaceBorderFormatting
-
setDiagonalBorderColor
- Specified by:
setDiagonalBorderColorin interfaceBorderFormatting
-
setLeftBorderColor
public void setLeftBorderColor(short color) - Specified by:
setLeftBorderColorin interfaceBorderFormatting
-
setLeftBorderColor
- Specified by:
setLeftBorderColorin interfaceBorderFormatting
-
setRightBorderColor
public void setRightBorderColor(short color) - Specified by:
setRightBorderColorin interfaceBorderFormatting
-
setRightBorderColor
- Specified by:
setRightBorderColorin interfaceBorderFormatting
-
setTopBorderColor
public void setTopBorderColor(short color) - Specified by:
setTopBorderColorin interfaceBorderFormatting
-
setTopBorderColor
- Specified by:
setTopBorderColorin interfaceBorderFormatting
-
getBorderVertical
HSSF doesn't support table borders, so alwaysBorderStyle.NONE- Specified by:
getBorderVerticalin interfaceBorderFormatting- Returns:
- border style
- See Also:
-
getBorderHorizontal
HSSF doesn't support table borders, so alwaysBorderStyle.NONE- Specified by:
getBorderHorizontalin interfaceBorderFormatting- Returns:
- border style
- See Also:
-
getBorderBottomEnum
- Specified by:
getBorderBottomEnumin interfaceBorderFormatting
-
getBorderDiagonalEnum
- Specified by:
getBorderDiagonalEnumin interfaceBorderFormatting
-
getBorderLeftEnum
- Specified by:
getBorderLeftEnumin interfaceBorderFormatting
-
getBorderRightEnum
- Specified by:
getBorderRightEnumin interfaceBorderFormatting
-
getBorderTopEnum
- Specified by:
getBorderTopEnumin interfaceBorderFormatting
-
getBorderVerticalEnum
Deprecated.HSSF doesn't support table borders, so alwaysBorderStyle.NONE- Specified by:
getBorderVerticalEnumin interfaceBorderFormatting- Returns:
- border style
- See Also:
-
getBorderHorizontalEnum
Deprecated.HSSF doesn't support table borders, so alwaysBorderStyle.NONE- Specified by:
getBorderHorizontalEnumin interfaceBorderFormatting- Returns:
- border style
- See Also:
-
getVerticalBorderColor
public short getVerticalBorderColor()HSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATIC- Specified by:
getVerticalBorderColorin interfaceBorderFormatting- Returns:
- color index
- See Also:
-
getVerticalBorderColorColor
HSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATIC- Specified by:
getVerticalBorderColorColorin interfaceBorderFormatting- Returns:
- color
- See Also:
-
getHorizontalBorderColor
public short getHorizontalBorderColor()HSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATIC- Specified by:
getHorizontalBorderColorin interfaceBorderFormatting- Returns:
- color index
- See Also:
-
getHorizontalBorderColorColor
HSSF Doesn't support table borders, so alwaysHSSFColor.HSSFColorPredefined.AUTOMATIC- Specified by:
getHorizontalBorderColorColorin interfaceBorderFormatting- Returns:
- color
- See Also:
-
setBorderHorizontal
Not available for HSSF.- Specified by:
setBorderHorizontalin interfaceBorderFormatting- Parameters:
border- The style of border to set.- See Also:
-
setBorderVertical
Not available for HSSF.- Specified by:
setBorderVerticalin interfaceBorderFormatting- Parameters:
border- The style of border to set.- See Also:
-
setHorizontalBorderColor
public void setHorizontalBorderColor(short color) Not available for HSSF.- Specified by:
setHorizontalBorderColorin interfaceBorderFormatting- Parameters:
color- index- See Also:
-
setHorizontalBorderColor
Not available for HSSF.- Specified by:
setHorizontalBorderColorin interfaceBorderFormatting- Parameters:
color- index- See Also:
-
setVerticalBorderColor
public void setVerticalBorderColor(short color) Not available for HSSF.- Specified by:
setVerticalBorderColorin interfaceBorderFormatting- Parameters:
color- index- See Also:
-
setVerticalBorderColor
Not available for HSSF.- Specified by:
setVerticalBorderColorin interfaceBorderFormatting- Parameters:
color- index- See Also:
-