Top Description Fields Constructors Methods
org.apache.poi.hssf.usermodel

public final Class HSSFBorderFormatting

extends Object
implements BorderFormatting
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.usermodel.BorderFormatting
Imports
org.apache.poi.hssf.record.CFRuleBase, org.apache.poi.hssf.record.cf.BorderFormatting, org.apache.poi.hssf.util.HSSFColor, .HSSFColor.HSSFColorPredefined, org.apache.poi.ss.usermodel.BorderStyle, .Color
High level representation for Border Formatting component of Conditional Formatting settings

Field Summary

Modifier and TypeField and Description
private final BorderFormatting
borderFormatting

private final CFRuleBase
cfRuleRecord

private final HSSFWorkbook
workbook

Constructor Summary

AccessConstructor and Description
protected
HSSFBorderFormatting(CFRuleBase cfRuleRecord, HSSFWorkbook workbook)

Method Summary

Modifier and TypeMethod and Description
public BorderStyle
getBorderBottom()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderBottom.

public BorderStyle
getBorderDiagonal()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderDiagonal.

protected BorderFormatting
getBorderFormattingBlock()

public BorderStyle
getBorderHorizontal()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderHorizontal.

HSSF doesn't support table borders, so always BorderStyle#NONE

public BorderStyle
getBorderLeft()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderLeft.

public BorderStyle
getBorderRight()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderRight.

public BorderStyle
getBorderTop()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderTop.

public BorderStyle
getBorderVertical()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderVertical.

HSSF doesn't support table borders, so always BorderStyle#NONE

public short
getBottomBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBottomBorderColor.

public HSSFColor
getBottomBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBottomBorderColorColor.

public short
getDiagonalBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getDiagonalBorderColor.

public HSSFColor
getDiagonalBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getDiagonalBorderColorColor.

public short
getHorizontalBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getHorizontalBorderColor.

HSSF Doesn't support table borders, so always HSSFColorPredefined#AUTOMATIC

public Color
getHorizontalBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getHorizontalBorderColorColor.

HSSF Doesn't support table borders, so always HSSFColorPredefined#AUTOMATIC

public short
getLeftBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getLeftBorderColor.

public HSSFColor
getLeftBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getLeftBorderColorColor.

public short
getRightBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getRightBorderColor.

public HSSFColor
getRightBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getRightBorderColorColor.

public short
getTopBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getTopBorderColor.

public HSSFColor
getTopBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getTopBorderColorColor.

public short
getVerticalBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getVerticalBorderColor.

HSSF Doesn't support table borders, so always HSSFColorPredefined#AUTOMATIC

public Color
getVerticalBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getVerticalBorderColorColor.

HSSF Doesn't support table borders, so always HSSFColorPredefined#AUTOMATIC

public boolean
isBackwardDiagonalOn()

public boolean
isForwardDiagonalOn()

public void
setBackwardDiagonalOn(boolean on)

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

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderBottom.

Set bottom border.

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

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderDiagonal.

Set diagonal border.

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

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderHorizontal.

Not available for HSSF.

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

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderLeft.

Set left border.

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

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderRight.

Set right border.

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

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderTop.

Set top border.

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

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderVertical.

Not available for HSSF.

public void
setBottomBorderColor(short color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBottomBorderColor.

public void
setBottomBorderColor(Color color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBottomBorderColor.

public void
setDiagonalBorderColor(short color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setDiagonalBorderColor.

public void
setDiagonalBorderColor(Color color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setDiagonalBorderColor.

public void
setForwardDiagonalOn(boolean on)

public void
setHorizontalBorderColor(short
index
color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setHorizontalBorderColor.

Not available for HSSF.

public void
setHorizontalBorderColor(Color
index
color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setHorizontalBorderColor.

Not available for HSSF.

public void
setLeftBorderColor(short color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setLeftBorderColor.

public void
setLeftBorderColor(Color color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setLeftBorderColor.

public void
setRightBorderColor(short color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setRightBorderColor.

public void
setRightBorderColor(Color color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setRightBorderColor.

public void
setTopBorderColor(short color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setTopBorderColor.

public void
setTopBorderColor(Color color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setTopBorderColor.

public void
setVerticalBorderColor(short
index
color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setVerticalBorderColor.

Not available for HSSF.

public void
setVerticalBorderColor(Color
index
color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setVerticalBorderColor.

Not available for HSSF.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

borderFormattingback to summary
private final BorderFormatting borderFormatting
cfRuleRecordback to summary
private final CFRuleBase cfRuleRecord
workbookback to summary
private final HSSFWorkbook workbook

Constructor Detail

HSSFBorderFormattingback to summary
protected HSSFBorderFormatting(CFRuleBase cfRuleRecord, HSSFWorkbook workbook)

Method Detail

getBorderBottomback to summary
public BorderStyle getBorderBottom()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderBottom.

Annotations
@Override
getBorderDiagonalback to summary
public BorderStyle getBorderDiagonal()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderDiagonal.

Annotations
@Override
getBorderFormattingBlockback to summary
protected BorderFormatting getBorderFormattingBlock()
getBorderHorizontalback to summary
public BorderStyle getBorderHorizontal()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderHorizontal.

HSSF doesn't support table borders, so always BorderStyle#NONE

Returns:BorderStyle

Doc from org.apache.poi.ss.usermodel.BorderFormatting.getBorderHorizontal.

border style

See Also
org.apache.poi.ss.usermodel.BorderFormatting#getBorderHorizontal()
getBorderLeftback to summary
public BorderStyle getBorderLeft()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderLeft.

Annotations
@Override
getBorderRightback to summary
public BorderStyle getBorderRight()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderRight.

Annotations
@Override
getBorderTopback to summary
public BorderStyle getBorderTop()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderTop.

Annotations
@Override
getBorderVerticalback to summary
public BorderStyle getBorderVertical()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBorderVertical.

HSSF doesn't support table borders, so always BorderStyle#NONE

Returns:BorderStyle

Doc from org.apache.poi.ss.usermodel.BorderFormatting.getBorderVertical.

border style

See Also
org.apache.poi.ss.usermodel.BorderFormatting#getBorderVertical()
getBottomBorderColorback to summary
public short getBottomBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBottomBorderColor.

Annotations
@Override
getBottomBorderColorColorback to summary
public HSSFColor getBottomBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getBottomBorderColorColor.

Annotations
@Override
getDiagonalBorderColorback to summary
public short getDiagonalBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getDiagonalBorderColor.

Annotations
@Override
getDiagonalBorderColorColorback to summary
public HSSFColor getDiagonalBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getDiagonalBorderColorColor.

Annotations
@Override
getHorizontalBorderColorback to summary
public short getHorizontalBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getHorizontalBorderColor.

HSSF Doesn't support table borders, so always HSSFColorPredefined#AUTOMATIC

Returns:short

Doc from org.apache.poi.ss.usermodel.BorderFormatting.getHorizontalBorderColor.

color index

See Also
org.apache.poi.ss.usermodel.BorderFormatting#getHorizontalBorderColor()
getHorizontalBorderColorColorback to summary
public Color getHorizontalBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getHorizontalBorderColorColor.

HSSF Doesn't support table borders, so always HSSFColorPredefined#AUTOMATIC

Returns:Color

Doc from org.apache.poi.ss.usermodel.BorderFormatting.getHorizontalBorderColorColor.

color

See Also
org.apache.poi.ss.usermodel.BorderFormatting#getHorizontalBorderColorColor()
getLeftBorderColorback to summary
public short getLeftBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getLeftBorderColor.

Annotations
@Override
getLeftBorderColorColorback to summary
public HSSFColor getLeftBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getLeftBorderColorColor.

Annotations
@Override
getRightBorderColorback to summary
public short getRightBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getRightBorderColor.

Annotations
@Override
getRightBorderColorColorback to summary
public HSSFColor getRightBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getRightBorderColorColor.

Annotations
@Override
getTopBorderColorback to summary
public short getTopBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getTopBorderColor.

Annotations
@Override
getTopBorderColorColorback to summary
public HSSFColor getTopBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getTopBorderColorColor.

Annotations
@Override
getVerticalBorderColorback to summary
public short getVerticalBorderColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getVerticalBorderColor.

HSSF Doesn't support table borders, so always HSSFColorPredefined#AUTOMATIC

Returns:short

Doc from org.apache.poi.ss.usermodel.BorderFormatting.getVerticalBorderColor.

color index

See Also
org.apache.poi.ss.usermodel.BorderFormatting#getVerticalBorderColor()
getVerticalBorderColorColorback to summary
public Color getVerticalBorderColorColor()

Implements org.apache.poi.ss.usermodel.BorderFormatting.getVerticalBorderColorColor.

HSSF Doesn't support table borders, so always HSSFColorPredefined#AUTOMATIC

Returns:Color

Doc from org.apache.poi.ss.usermodel.BorderFormatting.getVerticalBorderColorColor.

color

See Also
org.apache.poi.ss.usermodel.BorderFormatting#getVerticalBorderColorColor()
isBackwardDiagonalOnback to summary
public boolean isBackwardDiagonalOn()
isForwardDiagonalOnback to summary
public boolean isForwardDiagonalOn()
setBackwardDiagonalOnback to summary
public void setBackwardDiagonalOn(boolean on)
setBorderBottomback to summary
public void setBorderBottom(BorderStyle border)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderBottom.

Doc from org.apache.poi.ss.usermodel.BorderFormatting.setBorderBottom.

Set bottom border.

Parameters
border:BorderStyle

The style of border to set.

Annotations
@Override
setBorderDiagonalback to summary
public void setBorderDiagonal(BorderStyle border)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderDiagonal.

Doc from org.apache.poi.ss.usermodel.BorderFormatting.setBorderDiagonal.

Set diagonal border.

Parameters
border:BorderStyle

The style of border to set.

Annotations
@Override
setBorderHorizontalback to summary
public void setBorderHorizontal(BorderStyle border)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderHorizontal.

Not available for HSSF.

Parameters
border:BorderStyle

Doc from org.apache.poi.ss.usermodel.BorderFormatting.setBorderHorizontal.

The style of border to set.

See Also
org.apache.poi.ss.usermodel.BorderFormatting#setBorderHorizontal(org.apache.poi.ss.usermodel.BorderStyle)
setBorderLeftback to summary
public void setBorderLeft(BorderStyle border)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderLeft.

Doc from org.apache.poi.ss.usermodel.BorderFormatting.setBorderLeft.

Set left border.

Parameters
border:BorderStyle

The style of border to set.

Annotations
@Override
setBorderRightback to summary
public void setBorderRight(BorderStyle border)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderRight.

Doc from org.apache.poi.ss.usermodel.BorderFormatting.setBorderRight.

Set right border.

Parameters
border:BorderStyle

The style of border to set.

Annotations
@Override
setBorderTopback to summary
public void setBorderTop(BorderStyle border)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderTop.

Doc from org.apache.poi.ss.usermodel.BorderFormatting.setBorderTop.

Set top border.

Parameters
border:BorderStyle

The style of border to set.

Annotations
@Override
setBorderVerticalback to summary
public void setBorderVertical(BorderStyle border)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBorderVertical.

Not available for HSSF.

Parameters
border:BorderStyle

Doc from org.apache.poi.ss.usermodel.BorderFormatting.setBorderVertical.

The style of border to set.

See Also
org.apache.poi.ss.usermodel.BorderFormatting#setBorderVertical(org.apache.poi.ss.usermodel.BorderStyle)
setBottomBorderColorback to summary
public void setBottomBorderColor(short color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBottomBorderColor.

Annotations
@Override
setBottomBorderColorback to summary
public void setBottomBorderColor(Color color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setBottomBorderColor.

setDiagonalBorderColorback to summary
public void setDiagonalBorderColor(short color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setDiagonalBorderColor.

Annotations
@Override
setDiagonalBorderColorback to summary
public void setDiagonalBorderColor(Color color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setDiagonalBorderColor.

Annotations
@Override
setForwardDiagonalOnback to summary
public void setForwardDiagonalOn(boolean on)
setHorizontalBorderColorback to summary
public void setHorizontalBorderColor(short color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setHorizontalBorderColor.

Not available for HSSF.

Parameters
color:short

Doc from org.apache.poi.ss.usermodel.BorderFormatting.setHorizontalBorderColor.

index

See Also
org.apache.poi.ss.usermodel.BorderFormatting#setHorizontalBorderColor(short)
setHorizontalBorderColorback to summary
public void setHorizontalBorderColor(Color color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setHorizontalBorderColor.

Not available for HSSF.

Parameters
color:Color

Doc from org.apache.poi.ss.usermodel.BorderFormatting.setHorizontalBorderColor.

index

See Also
org.apache.poi.ss.usermodel.BorderFormatting#setHorizontalBorderColor(org.apache.poi.ss.usermodel.Color)
setLeftBorderColorback to summary
public void setLeftBorderColor(short color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setLeftBorderColor.

Annotations
@Override
setLeftBorderColorback to summary
public void setLeftBorderColor(Color color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setLeftBorderColor.

Annotations
@Override
setRightBorderColorback to summary
public void setRightBorderColor(short color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setRightBorderColor.

Annotations
@Override
setRightBorderColorback to summary
public void setRightBorderColor(Color color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setRightBorderColor.

Annotations
@Override
setTopBorderColorback to summary
public void setTopBorderColor(short color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setTopBorderColor.

Annotations
@Override
setTopBorderColorback to summary
public void setTopBorderColor(Color color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setTopBorderColor.

Annotations
@Override
setVerticalBorderColorback to summary
public void setVerticalBorderColor(short color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setVerticalBorderColor.

Not available for HSSF.

Parameters
color:short

Doc from org.apache.poi.ss.usermodel.BorderFormatting.setVerticalBorderColor.

index

See Also
org.apache.poi.ss.usermodel.BorderFormatting#setVerticalBorderColor(short)
setVerticalBorderColorback to summary
public void setVerticalBorderColor(Color color)

Implements org.apache.poi.ss.usermodel.BorderFormatting.setVerticalBorderColor.

Not available for HSSF.

Parameters
color:Color

Doc from org.apache.poi.ss.usermodel.BorderFormatting.setVerticalBorderColor.

index

See Also
org.apache.poi.ss.usermodel.BorderFormatting#setVerticalBorderColor(org.apache.poi.ss.usermodel.Color)