Top Description Methods
org.apache.poi.ss.usermodel

public Interface BorderFormatting

Known Direct Implementers
org.apache.poi.hssf.usermodel.HSSFBorderFormatting
High level representation for Border Formatting component of Conditional Formatting settings

Method Summary

Modifier and TypeMethod and Description
public BorderStyle
getBorderBottom()

public BorderStyle
getBorderDiagonal()

public BorderStyle

Returns:

border style
getBorderHorizontal()

Only valid for range borders, such as table styles

public BorderStyle
getBorderLeft()

public BorderStyle
getBorderRight()

public BorderStyle
getBorderTop()

public BorderStyle

Returns:

border style
getBorderVertical()

Only valid for range borders, such as table styles

public short
getBottomBorderColor()

public Color
getBottomBorderColorColor()

public short
getDiagonalBorderColor()

public Color
getDiagonalBorderColorColor()

public short

Returns:

color index
getHorizontalBorderColor()

Range internal borders.

public Color

Returns:

color
getHorizontalBorderColorColor()

Range internal borders.

public short
getLeftBorderColor()

public Color
getLeftBorderColorColor()

public short
getRightBorderColor()

public Color
getRightBorderColorColor()

public short
getTopBorderColor()

public Color
getTopBorderColorColor()

public short

Returns:

color index
getVerticalBorderColor()

Range internal borders.

public Color

Returns:

color
getVerticalBorderColorColor()

Range internal borders.

public void
setBorderBottom(BorderStyle
The style of border to set.
border)

Set bottom border.

public void
setBorderDiagonal(BorderStyle
The style of border to set.
border)

Set diagonal border.

public void
setBorderHorizontal(BorderStyle
The style of border to set.
border)

Set range internal horizontal borders.

public void
setBorderLeft(BorderStyle
The style of border to set.
border)

Set left border.

public void
setBorderRight(BorderStyle
The style of border to set.
border)

Set right border.

public void
setBorderTop(BorderStyle
The style of border to set.
border)

Set top border.

public void
setBorderVertical(BorderStyle
The style of border to set.
border)

Set range internal vertical borders.

public void
setBottomBorderColor(short color)

public void
setBottomBorderColor(Color color)

public void
setDiagonalBorderColor(short color)

public void
setDiagonalBorderColor(Color color)

public void
setHorizontalBorderColor(short
index
color)

Range internal border color, such as table styles

public void
setHorizontalBorderColor(Color
index
color)

Range internal border color, such as table styles

public void
setLeftBorderColor(short color)

public void
setLeftBorderColor(Color color)

public void
setRightBorderColor(short color)

public void
setRightBorderColor(Color color)

public void
setTopBorderColor(short color)

public void
setTopBorderColor(Color color)

public void
setVerticalBorderColor(short
index
color)

Range internal border color, such as table styles

public void
setVerticalBorderColor(Color
index
color)

Range internal border color, such as table styles

Method Detail

getBorderBottomback to summary
public BorderStyle getBorderBottom()
Since
POI 4.0.0
getBorderDiagonalback to summary
public BorderStyle getBorderDiagonal()
Since
POI 4.0.0
getBorderHorizontalback to summary
public BorderStyle getBorderHorizontal()

Only valid for range borders, such as table styles

Returns:BorderStyle

border style

Since
4.0.0
getBorderLeftback to summary
public BorderStyle getBorderLeft()
Since
POI 4.0.0
getBorderRightback to summary
public BorderStyle getBorderRight()
Since
POI 4.0.0
getBorderTopback to summary
public BorderStyle getBorderTop()
Since
POI 4.0.0
getBorderVerticalback to summary
public BorderStyle getBorderVertical()

Only valid for range borders, such as table styles

Returns:BorderStyle

border style

Since
4.0.0
getBottomBorderColorback to summary
public short getBottomBorderColor()
getBottomBorderColorColorback to summary
public Color getBottomBorderColorColor()
getDiagonalBorderColorback to summary
public short getDiagonalBorderColor()
getDiagonalBorderColorColorback to summary
public Color getDiagonalBorderColorColor()
getHorizontalBorderColorback to summary
public short getHorizontalBorderColor()

Range internal borders. Only relevant for range styles, such as table formatting

Returns:short

color index

Since
3.17 beta 1
getHorizontalBorderColorColorback to summary
public Color getHorizontalBorderColorColor()

Range internal borders. Only relevant for range styles, such as table formatting

Returns:Color

color

Since
3.17 beta 1
getLeftBorderColorback to summary
public short getLeftBorderColor()
getLeftBorderColorColorback to summary
public Color getLeftBorderColorColor()
getRightBorderColorback to summary
public short getRightBorderColor()
getRightBorderColorColorback to summary
public Color getRightBorderColorColor()
getTopBorderColorback to summary
public short getTopBorderColor()
getTopBorderColorColorback to summary
public Color getTopBorderColorColor()
getVerticalBorderColorback to summary
public short getVerticalBorderColor()

Range internal borders. Only relevant for range styles, such as table formatting

Returns:short

color index

Since
3.17 beta 1
getVerticalBorderColorColorback to summary
public Color getVerticalBorderColorColor()

Range internal borders. Only relevant for range styles, such as table formatting

Returns:Color

color

Since
3.17 beta 1
setBorderBottomback to summary
public void setBorderBottom(BorderStyle border)

Set bottom border.

Parameters
border:BorderStyle

The style of border to set.

setBorderDiagonalback to summary
public void setBorderDiagonal(BorderStyle border)

Set diagonal border.

Parameters
border:BorderStyle

The style of border to set.

setBorderHorizontalback to summary
public void setBorderHorizontal(BorderStyle border)

Set range internal horizontal borders.

Parameters
border:BorderStyle

The style of border to set.

Since
3.17 beta 1
setBorderLeftback to summary
public void setBorderLeft(BorderStyle border)

Set left border.

Parameters
border:BorderStyle

The style of border to set.

setBorderRightback to summary
public void setBorderRight(BorderStyle border)

Set right border.

Parameters
border:BorderStyle

The style of border to set.

setBorderTopback to summary
public void setBorderTop(BorderStyle border)

Set top border.

Parameters
border:BorderStyle

The style of border to set.

setBorderVerticalback to summary
public void setBorderVertical(BorderStyle border)

Set range internal vertical borders.

Parameters
border:BorderStyle

The style of border to set.

Since
3.17 beta 1
setBottomBorderColorback to summary
public void setBottomBorderColor(short color)
setBottomBorderColorback to summary
public void setBottomBorderColor(Color color)
setDiagonalBorderColorback to summary
public void setDiagonalBorderColor(short color)
setDiagonalBorderColorback to summary
public void setDiagonalBorderColor(Color color)
setHorizontalBorderColorback to summary
public void setHorizontalBorderColor(short color)

Range internal border color, such as table styles

Parameters
color:short

index

Since
3.17 beta 1
setHorizontalBorderColorback to summary
public void setHorizontalBorderColor(Color color)

Range internal border color, such as table styles

Parameters
color:Color

index

Since
3.17 beta 1
setLeftBorderColorback to summary
public void setLeftBorderColor(short color)
setLeftBorderColorback to summary
public void setLeftBorderColor(Color color)
setRightBorderColorback to summary
public void setRightBorderColor(short color)
setRightBorderColorback to summary
public void setRightBorderColor(Color color)
setTopBorderColorback to summary
public void setTopBorderColor(short color)
setTopBorderColorback to summary
public void setTopBorderColor(Color color)
setVerticalBorderColorback to summary
public void setVerticalBorderColor(short color)

Range internal border color, such as table styles

Parameters
color:short

index

Since
3.17 beta 1
setVerticalBorderColorback to summary
public void setVerticalBorderColor(Color color)

Range internal border color, such as table styles

Parameters
color:Color

index

Since
3.17 beta 1