XSSFBorderFormatting (POI API Documentation)

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

Field Summary
- Fields inherited from interface org.apache.poi.ss.usermodel.BorderFormatting
  BORDER_DASH_DOT, BORDER_DASH_DOT_DOT, BORDER_DASHED, BORDER_DOTTED, BORDER_DOUBLE, BORDER_HAIR, BORDER_MEDIUM, BORDER_MEDIUM_DASH_DOT, BORDER_MEDIUM_DASH_DOT_DOT, BORDER_MEDIUM_DASHED, BORDER_NONE, BORDER_SLANTED_DASH_DOT, BORDER_THICK, BORDER_THIN

Method Summary

Methods
Modifier and Type	Method and Description
`short`	`getBorderBottom()` Deprecated. POI 3.15. Use `getBorderBottomEnum()`. This method will return an BorderStyle enum in the future.
`BorderStyle`	`getBorderBottomEnum()`
`short`	`getBorderDiagonal()` Deprecated. POI 3.15. Use `getBorderDiagonalEnum()`. This method will return an BorderStyle enum in the future.
`BorderStyle`	`getBorderDiagonalEnum()`
`short`	`getBorderLeft()` Deprecated. POI 3.15. Use `getBorderLeftEnum()`. This method will return an BorderStyle enum in the future.
`BorderStyle`	`getBorderLeftEnum()`
`short`	`getBorderRight()` Deprecated. POI 3.15. Use `getBorderRightEnum()`. This method will return an BorderStyle enum in the future.
`BorderStyle`	`getBorderRightEnum()`
`short`	`getBorderTop()` Deprecated. POI 3.15. Use `getBorderTopEnum()`. This method will return an BorderStyle enum in the future.
`BorderStyle`	`getBorderTopEnum()`
`short`	`getBottomBorderColor()`
`XSSFColor`	`getBottomBorderColorColor()`
`short`	`getDiagonalBorderColor()`
`XSSFColor`	`getDiagonalBorderColorColor()`
`short`	`getLeftBorderColor()`
`XSSFColor`	`getLeftBorderColorColor()`
`short`	`getRightBorderColor()`
`XSSFColor`	`getRightBorderColorColor()`
`short`	`getTopBorderColor()`
`XSSFColor`	`getTopBorderColorColor()`
`void`	`setBorderBottom(BorderStyle border)`
`void`	`setBorderBottom(short border)` Deprecated. 3.15 beta 2. Use `setBorderBottom(BorderStyle)`
`void`	`setBorderDiagonal(BorderStyle border)`
`void`	`setBorderDiagonal(short border)` Deprecated. 3.15 beta 2. Use `setBorderDiagonal(BorderStyle)`
`void`	`setBorderLeft(BorderStyle border)`
`void`	`setBorderLeft(short border)` Deprecated. 3.15 beta 2. Use `setBorderLeft(BorderStyle)`
`void`	`setBorderRight(BorderStyle border)`
`void`	`setBorderRight(short border)` Deprecated. 3.15 beta 2. Use `setBorderRight(BorderStyle)`
`void`	`setBorderTop(BorderStyle border)`
`void`	`setBorderTop(short border)` Deprecated. 3.15 beta 2. Use `setBorderTop(BorderStyle)`
`void`	`setBottomBorderColor(Color color)`
`void`	`setBottomBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)`
`void`	`setBottomBorderColor(short color)`
`void`	`setDiagonalBorderColor(Color color)`
`void`	`setDiagonalBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)`
`void`	`setDiagonalBorderColor(short color)`
`void`	`setLeftBorderColor(Color color)`
`void`	`setLeftBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)`
`void`	`setLeftBorderColor(short color)`
`void`	`setRightBorderColor(Color color)`
`void`	`setRightBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)`
`void`	`setRightBorderColor(short color)`
`void`	`setTopBorderColor(Color color)`
`void`	`setTopBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)`
`void`	`setTopBorderColor(short color)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getBorderBottom
```
public short getBorderBottom()
```
    Deprecated. POI 3.15. Use getBorderBottomEnum(). This method will return an BorderStyle enum in the future.
    
    Specified by:
    
    getBorderBottom in interface BorderFormatting
  - getBorderBottomEnum
```
public BorderStyle getBorderBottomEnum()
```
    Specified by:
    
    getBorderBottomEnum in interface BorderFormatting
    
    Since:
    
    POI 3.15
  - getBorderDiagonal
```
public short getBorderDiagonal()
```
    Deprecated. POI 3.15. Use getBorderDiagonalEnum(). This method will return an BorderStyle enum in the future.
    
    Specified by:
    
    getBorderDiagonal in interface BorderFormatting
  - getBorderDiagonalEnum
```
public BorderStyle getBorderDiagonalEnum()
```
    Specified by:
    
    getBorderDiagonalEnum in interface BorderFormatting
    
    Since:
    
    POI 3.15
  - getBorderLeft
```
public short getBorderLeft()
```
    Deprecated. POI 3.15. Use getBorderLeftEnum(). This method will return an BorderStyle enum in the future.
    
    Specified by:
    
    getBorderLeft in interface BorderFormatting
  - getBorderLeftEnum
```
public BorderStyle getBorderLeftEnum()
```
    Specified by:
    
    getBorderLeftEnum in interface BorderFormatting
    
    Since:
    
    POI 3.15
  - getBorderRight
```
public short getBorderRight()
```
    Deprecated. POI 3.15. Use getBorderRightEnum(). This method will return an BorderStyle enum in the future.
    
    Specified by:
    
    getBorderRight in interface BorderFormatting
  - getBorderRightEnum
```
public BorderStyle getBorderRightEnum()
```
    Specified by:
    
    getBorderRightEnum in interface BorderFormatting
    
    Since:
    
    POI 3.15
  - getBorderTop
```
public short getBorderTop()
```
    Deprecated. POI 3.15. Use getBorderTopEnum(). This method will return an BorderStyle enum in the future.
    
    Specified by:
    
    getBorderTop in interface BorderFormatting
  - getBorderTopEnum
```
public BorderStyle getBorderTopEnum()
```
    Specified by:
    
    getBorderTopEnum in interface BorderFormatting
    
    Since:
    
    POI 3.15
  - getBottomBorderColorColor
```
public XSSFColor getBottomBorderColorColor()
```
    Specified by:
    
    getBottomBorderColorColor in interface BorderFormatting
  - getBottomBorderColor
```
public short getBottomBorderColor()
```
    Specified by:
    
    getBottomBorderColor in interface BorderFormatting
  - getDiagonalBorderColorColor
```
public XSSFColor getDiagonalBorderColorColor()
```
    Specified by:
    
    getDiagonalBorderColorColor in interface BorderFormatting
  - getDiagonalBorderColor
```
public short getDiagonalBorderColor()
```
    Specified by:
    
    getDiagonalBorderColor in interface BorderFormatting
  - getLeftBorderColorColor
```
public XSSFColor getLeftBorderColorColor()
```
    Specified by:
    
    getLeftBorderColorColor in interface BorderFormatting
  - getLeftBorderColor
```
public short getLeftBorderColor()
```
    Specified by:
    
    getLeftBorderColor in interface BorderFormatting
  - getRightBorderColorColor
```
public XSSFColor getRightBorderColorColor()
```
    Specified by:
    
    getRightBorderColorColor in interface BorderFormatting
  - getRightBorderColor
```
public short getRightBorderColor()
```
    Specified by:
    
    getRightBorderColor in interface BorderFormatting
  - getTopBorderColorColor
```
public XSSFColor getTopBorderColorColor()
```
    Specified by:
    
    getTopBorderColorColor in interface BorderFormatting
  - getTopBorderColor
```
public short getTopBorderColor()
```
    Specified by:
    
    getTopBorderColor in interface BorderFormatting
  - setBorderBottom
```
public void setBorderBottom(short border)
```
    Deprecated. 3.15 beta 2. Use setBorderBottom(BorderStyle)
    
    Specified by:
    
    setBorderBottom in interface BorderFormatting
  - setBorderBottom
```
public void setBorderBottom(BorderStyle border)
```
    Specified by:
    
    setBorderBottom in interface BorderFormatting
  - setBorderDiagonal
```
public void setBorderDiagonal(short border)
```
    Deprecated. 3.15 beta 2. Use setBorderDiagonal(BorderStyle)
    
    Specified by:
    
    setBorderDiagonal in interface BorderFormatting
  - setBorderDiagonal
```
public void setBorderDiagonal(BorderStyle border)
```
    Specified by:
    
    setBorderDiagonal in interface BorderFormatting
  - setBorderLeft
```
public void setBorderLeft(short border)
```
    Deprecated. 3.15 beta 2. Use setBorderLeft(BorderStyle)
    
    Specified by:
    
    setBorderLeft in interface BorderFormatting
  - setBorderLeft
```
public void setBorderLeft(BorderStyle border)
```
    Specified by:
    
    setBorderLeft in interface BorderFormatting
  - setBorderRight
```
public void setBorderRight(short border)
```
    Deprecated. 3.15 beta 2. Use setBorderRight(BorderStyle)
    
    Specified by:
    
    setBorderRight in interface BorderFormatting
  - setBorderRight
```
public void setBorderRight(BorderStyle border)
```
    Specified by:
    
    setBorderRight in interface BorderFormatting
  - setBorderTop
```
public void setBorderTop(short border)
```
    Deprecated. 3.15 beta 2. Use setBorderTop(BorderStyle)
    
    Specified by:
    
    setBorderTop in interface BorderFormatting
  - setBorderTop
```
public void setBorderTop(BorderStyle border)
```
    Specified by:
    
    setBorderTop in interface BorderFormatting
  - setBottomBorderColor
```
public void setBottomBorderColor(Color color)
```
    Specified by:
    
    setBottomBorderColor in interface BorderFormatting
  - setBottomBorderColor
```
public void setBottomBorderColor(short color)
```
    Specified by:
    
    setBottomBorderColor in interface BorderFormatting
  - setBottomBorderColor
```
public void setBottomBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)
```
  - setDiagonalBorderColor
```
public void setDiagonalBorderColor(Color color)
```
    Specified by:
    
    setDiagonalBorderColor in interface BorderFormatting
  - setDiagonalBorderColor
```
public void setDiagonalBorderColor(short color)
```
    Specified by:
    
    setDiagonalBorderColor in interface BorderFormatting
  - setDiagonalBorderColor
```
public void setDiagonalBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)
```
  - setLeftBorderColor
```
public void setLeftBorderColor(Color color)
```
    Specified by:
    
    setLeftBorderColor in interface BorderFormatting
  - setLeftBorderColor
```
public void setLeftBorderColor(short color)
```
    Specified by:
    
    setLeftBorderColor in interface BorderFormatting
  - setLeftBorderColor
```
public void setLeftBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)
```
  - setRightBorderColor
```
public void setRightBorderColor(Color color)
```
    Specified by:
    
    setRightBorderColor in interface BorderFormatting
  - setRightBorderColor
```
public void setRightBorderColor(short color)
```
    Specified by:
    
    setRightBorderColor in interface BorderFormatting
  - setRightBorderColor
```
public void setRightBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)
```
  - setTopBorderColor
```
public void setTopBorderColor(Color color)
```
    Specified by:
    
    setTopBorderColor in interface BorderFormatting
  - setTopBorderColor
```
public void setTopBorderColor(short color)
```
    Specified by:
    
    setTopBorderColor in interface BorderFormatting
  - setTopBorderColor
```
public void setTopBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)
```

Class XSSFBorderFormatting

Field Summary

Fields inherited from interface org.apache.poi.ss.usermodel.BorderFormatting

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getBorderBottom

getBorderBottomEnum

getBorderDiagonal

getBorderDiagonalEnum

getBorderLeft

getBorderLeftEnum

getBorderRight

getBorderRightEnum

getBorderTop

getBorderTopEnum

getBottomBorderColorColor

getBottomBorderColor

getDiagonalBorderColorColor

getDiagonalBorderColor

getLeftBorderColorColor

getLeftBorderColor

getRightBorderColorColor

getRightBorderColor

getTopBorderColorColor

getTopBorderColor

setBorderBottom

setBorderBottom

setBorderDiagonal

setBorderDiagonal

setBorderLeft

setBorderLeft

setBorderRight

setBorderRight

setBorderTop

setBorderTop

setBottomBorderColor

setBottomBorderColor

setBottomBorderColor

setDiagonalBorderColor

setDiagonalBorderColor

setDiagonalBorderColor

setLeftBorderColor

setLeftBorderColor

setLeftBorderColor

setRightBorderColor

setRightBorderColor

setRightBorderColor

setTopBorderColor

setTopBorderColor

setTopBorderColor