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