Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.cf.BorderFormatting

Field Summary

Modifier and Type	Field and Description
private static final BitField	bordBlTrtLineOnOff
private static final BitField	bordBottomLineColor
private static final BitField	bordBottomLineStyle
private static final BitField	bordDiagLineColor
private static final BitField	bordDiagLineStyle
public static final short	BORDER_DASH_DOT dash-dot border
public static final short	BORDER_DASH_DOT_DOT dash-dot-dot border
public static final short	BORDER_DASHED dash border
public static final short	BORDER_DOTTED hair-line border
public static final short	BORDER_DOUBLE double-line border
public static final short	BORDER_HAIR dot border
public static final short	BORDER_MEDIUM Medium border
public static final short	BORDER_MEDIUM_DASH_DOT medium dash-dot border
public static final short	BORDER_MEDIUM_DASH_DOT_DOT medium dash-dot-dot border
public static final short	BORDER_MEDIUM_DASHED Medium dashed border
public static final short	BORDER_NONE No border
public static final short	BORDER_SLANTED_DASH_DOT slanted dash-dot border
public static final short	BORDER_THICK Thick border
public static final short	BORDER_THIN Thin border
private static final BitField	bordLeftLineColor
private static final BitField	bordLeftLineStyle
private static final BitField	bordRightLineColor
private static final BitField	bordRightLineStyle
private static final BitField	bordTlBrLineOnOff
private static final BitField	bordTopLineColor
private static final BitField	bordTopLineStyle
private int	field_13_border_styles1
private int	field_14_border_styles2

Constructor Summary

Access	Constructor and Description
public	BorderFormatting()
public	BorderFormatting(BorderFormatting other)
public	BorderFormatting(LittleEndianInput in) Creates new FontFormatting

Method Summary

Modifier and Type	Method and Description
public BorderFormatting	copy() Implements org.apache.poi.common.Duplicatable.copy.
public int	Returns: border type getBorderBottom() get the type of border to use for the bottom border of the cell
public int	Returns: border type getBorderDiagonal() get the type of border to use for the diagonal border of the cell
public int	Returns: border type getBorderLeft() get the type of border to use for the left border of the cell
public int	Returns: border type getBorderRight() get the type of border to use for the right border of the cell
public int	Returns: border type getBorderTop() get the type of border to use for the top border of the cell
public int	Returns: The index of the color definition getBottomBorderColor() get the color to use for the bottom border
public int	getDataLength()
public int	Returns: The index of the color definition getDiagonalBorderColor() get the color to use for the diagonal border
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public int	Returns: The index of the color definition getLeftBorderColor() get the color to use for the left border
public int	Returns: The index of the color definition getRightBorderColor() get the color to use for the right border
public int	Returns: The index of the color definition getTopBorderColor() get the color to use for the top border
public boolean	Returns: `true` if backward diagonal is on isBackwardDiagonalOn()
public boolean	Returns: `true` if forward diagonal is on isForwardDiagonalOn()
public int	serialize(int offset, byte[] data)
public void	serialize(LittleEndianOutput out)
public void	setBackwardDiagonalOn(boolean - if `true` - on, otherwise off on) Of/off top left to bottom right line
public void	setBorderBottom(int type border) set the type of border to use for the bottom border of the cell
public void	setBorderDiagonal(int type border) set the type of border to use for the diagonal border of the cell
public void	setBorderLeft(int type border) set the type of border to use for the left border of the cell
public void	setBorderRight(int type border) set the type of border to use for the right border of the cell
public void	setBorderTop(int type border) set the type of border to use for the top border of the cell
public void	setBottomBorderColor(int The index of the color definition color) set the color to use for the bottom border
public void	setDiagonalBorderColor(int The index of the color definition color) set the color to use for the diagonal borders
public void	setForwardDiagonalOn(boolean - if `true` - on, otherwise off on) Of/off bottom left to top right line
public void	setLeftBorderColor(int The index of the color definition color) set the color to use for the left border
public void	setRightBorderColor(int The index of the color definition color) set the color to use for the right border
public void	setTopBorderColor(int The index of the color definition color) set the color to use for the top border
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

bordBlTrtLineOnOff	back to summary
private static final BitField bordBlTrtLineOnOff

bordBottomLineColor	back to summary
private static final BitField bordBottomLineColor

bordBottomLineStyle	back to summary
private static final BitField bordBottomLineStyle

bordDiagLineColor	back to summary
private static final BitField bordDiagLineColor

bordDiagLineStyle	back to summary
private static final BitField bordDiagLineStyle

BORDER_DASH_DOT	back to summary
public static final short BORDER_DASH_DOT dash-dot border

BORDER_DASH_DOT_DOT	back to summary
public static final short BORDER_DASH_DOT_DOT dash-dot-dot border

BORDER_DASHED	back to summary
public static final short BORDER_DASHED dash border

BORDER_DOTTED	back to summary
public static final short BORDER_DOTTED hair-line border

BORDER_DOUBLE	back to summary
public static final short BORDER_DOUBLE double-line border

BORDER_HAIR	back to summary
public static final short BORDER_HAIR dot border

BORDER_MEDIUM	back to summary
public static final short BORDER_MEDIUM Medium border

BORDER_MEDIUM_DASH_DOT	back to summary
public static final short BORDER_MEDIUM_DASH_DOT medium dash-dot border

BORDER_MEDIUM_DASH_DOT_DOT	back to summary
public static final short BORDER_MEDIUM_DASH_DOT_DOT medium dash-dot-dot border

BORDER_MEDIUM_DASHED	back to summary
public static final short BORDER_MEDIUM_DASHED Medium dashed border

BORDER_NONE	back to summary
public static final short BORDER_NONE No border

BORDER_SLANTED_DASH_DOT	back to summary
public static final short BORDER_SLANTED_DASH_DOT slanted dash-dot border

BORDER_THICK	back to summary
public static final short BORDER_THICK Thick border

BORDER_THIN	back to summary
public static final short BORDER_THIN Thin border

bordLeftLineColor	back to summary
private static final BitField bordLeftLineColor

bordLeftLineStyle	back to summary
private static final BitField bordLeftLineStyle

bordRightLineColor	back to summary
private static final BitField bordRightLineColor

bordRightLineStyle	back to summary
private static final BitField bordRightLineStyle

bordTlBrLineOnOff	back to summary
private static final BitField bordTlBrLineOnOff

bordTopLineColor	back to summary
private static final BitField bordTopLineColor

bordTopLineStyle	back to summary
private static final BitField bordTopLineStyle

field_13_border_styles1	back to summary
private int field_13_border_styles1

field_14_border_styles2	back to summary
private int field_14_border_styles2

Constructor Detail

BorderFormatting	back to summary
public BorderFormatting()

BorderFormatting	back to summary
public BorderFormatting(BorderFormatting other)

BorderFormatting	back to summary
public BorderFormatting(LittleEndianInput in) Creates new FontFormatting

Method Detail

copy	back to summary
public BorderFormatting copy() Implements org.apache.poi.common.Duplicatable.copy. Returns:BorderFormatting Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance

copy

back to summary

public BorderFormatting copy()

Implements org.apache.poi.common.Duplicatable.copy.

Returns:BorderFormatting

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

getBorderBottom back to summary

getBorderBottom	back to summary
public int getBorderBottom() get the type of border to use for the bottom border of the cell Returns:int border type See Also `BORDER_NONE`, `BORDER_THIN`, `BORDER_MEDIUM`, `BORDER_DASHED`, `BORDER_DOTTED`, `BORDER_THICK`, `BORDER_DOUBLE`, `BORDER_HAIR`, `BORDER_MEDIUM_DASHED`, `BORDER_DASH_DOT`, `BORDER_MEDIUM_DASH_DOT`, `BORDER_DASH_DOT_DOT`, `BORDER_MEDIUM_DASH_DOT_DOT`, `BORDER_SLANTED_DASH_DOT`

public int getBorderBottom()

get the type of border to use for the bottom border of the cell

Returns:int: border type
See Also: BORDER_NONE, BORDER_THIN, BORDER_MEDIUM, BORDER_DASHED, BORDER_DOTTED, BORDER_THICK, BORDER_DOUBLE, BORDER_HAIR, BORDER_MEDIUM_DASHED, BORDER_DASH_DOT, BORDER_MEDIUM_DASH_DOT, BORDER_DASH_DOT_DOT, BORDER_MEDIUM_DASH_DOT_DOT, BORDER_SLANTED_DASH_DOT

getBorderDiagonal back to summary

getBorderDiagonal	back to summary
public int getBorderDiagonal() get the type of border to use for the diagonal border of the cell Returns:int border type See Also `BORDER_NONE`, `BORDER_THIN`, `BORDER_MEDIUM`, `BORDER_DASHED`, `BORDER_DOTTED`, `BORDER_THICK`, `BORDER_DOUBLE`, `BORDER_HAIR`, `BORDER_MEDIUM_DASHED`, `BORDER_DASH_DOT`, `BORDER_MEDIUM_DASH_DOT`, `BORDER_DASH_DOT_DOT`, `BORDER_MEDIUM_DASH_DOT_DOT`, `BORDER_SLANTED_DASH_DOT`

public int getBorderDiagonal()

get the type of border to use for the diagonal border of the cell

Returns:int: border type
See Also: BORDER_NONE, BORDER_THIN, BORDER_MEDIUM, BORDER_DASHED, BORDER_DOTTED, BORDER_THICK, BORDER_DOUBLE, BORDER_HAIR, BORDER_MEDIUM_DASHED, BORDER_DASH_DOT, BORDER_MEDIUM_DASH_DOT, BORDER_DASH_DOT_DOT, BORDER_MEDIUM_DASH_DOT_DOT, BORDER_SLANTED_DASH_DOT

getBorderLeft back to summary

getBorderLeft	back to summary
public int getBorderLeft() get the type of border to use for the left border of the cell Returns:int border type See Also `BORDER_NONE`, `BORDER_THIN`, `BORDER_MEDIUM`, `BORDER_DASHED`, `BORDER_DOTTED`, `BORDER_THICK`, `BORDER_DOUBLE`, `BORDER_HAIR`, `BORDER_MEDIUM_DASHED`, `BORDER_DASH_DOT`, `BORDER_MEDIUM_DASH_DOT`, `BORDER_DASH_DOT_DOT`, `BORDER_MEDIUM_DASH_DOT_DOT`, `BORDER_SLANTED_DASH_DOT`

public int getBorderLeft()

get the type of border to use for the left border of the cell

Returns:int: border type
See Also: BORDER_NONE, BORDER_THIN, BORDER_MEDIUM, BORDER_DASHED, BORDER_DOTTED, BORDER_THICK, BORDER_DOUBLE, BORDER_HAIR, BORDER_MEDIUM_DASHED, BORDER_DASH_DOT, BORDER_MEDIUM_DASH_DOT, BORDER_DASH_DOT_DOT, BORDER_MEDIUM_DASH_DOT_DOT, BORDER_SLANTED_DASH_DOT

getBorderRight back to summary

getBorderRight	back to summary
public int getBorderRight() get the type of border to use for the right border of the cell Returns:int border type See Also `BORDER_NONE`, `BORDER_THIN`, `BORDER_MEDIUM`, `BORDER_DASHED`, `BORDER_DOTTED`, `BORDER_THICK`, `BORDER_DOUBLE`, `BORDER_HAIR`, `BORDER_MEDIUM_DASHED`, `BORDER_DASH_DOT`, `BORDER_MEDIUM_DASH_DOT`, `BORDER_DASH_DOT_DOT`, `BORDER_MEDIUM_DASH_DOT_DOT`, `BORDER_SLANTED_DASH_DOT`

public int getBorderRight()

get the type of border to use for the right border of the cell

Returns:int: border type
See Also: BORDER_NONE, BORDER_THIN, BORDER_MEDIUM, BORDER_DASHED, BORDER_DOTTED, BORDER_THICK, BORDER_DOUBLE, BORDER_HAIR, BORDER_MEDIUM_DASHED, BORDER_DASH_DOT, BORDER_MEDIUM_DASH_DOT, BORDER_DASH_DOT_DOT, BORDER_MEDIUM_DASH_DOT_DOT, BORDER_SLANTED_DASH_DOT

getBorderTop back to summary

getBorderTop	back to summary
public int getBorderTop() get the type of border to use for the top border of the cell Returns:int border type See Also `BORDER_NONE`, `BORDER_THIN`, `BORDER_MEDIUM`, `BORDER_DASHED`, `BORDER_DOTTED`, `BORDER_THICK`, `BORDER_DOUBLE`, `BORDER_HAIR`, `BORDER_MEDIUM_DASHED`, `BORDER_DASH_DOT`, `BORDER_MEDIUM_DASH_DOT`, `BORDER_DASH_DOT_DOT`, `BORDER_MEDIUM_DASH_DOT_DOT`, `BORDER_SLANTED_DASH_DOT`

public int getBorderTop()

get the type of border to use for the top border of the cell

Returns:int: border type
See Also: BORDER_NONE, BORDER_THIN, BORDER_MEDIUM, BORDER_DASHED, BORDER_DOTTED, BORDER_THICK, BORDER_DOUBLE, BORDER_HAIR, BORDER_MEDIUM_DASHED, BORDER_DASH_DOT, BORDER_MEDIUM_DASH_DOT, BORDER_DASH_DOT_DOT, BORDER_MEDIUM_DASH_DOT_DOT, BORDER_SLANTED_DASH_DOT

getBottomBorderColor back to summary

getBottomBorderColor	back to summary
public int getBottomBorderColor() get the color to use for the bottom border Returns:int The index of the color definition See Also `org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)`

public int getBottomBorderColor()

get the color to use for the bottom border

Returns:int: The index of the color definition
See Also: org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)

getDataLength	back to summary
public int getDataLength()

getDiagonalBorderColor back to summary

getDiagonalBorderColor	back to summary
public int getDiagonalBorderColor() get the color to use for the diagonal border Returns:int The index of the color definition See Also `org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)`

public int getDiagonalBorderColor()

get the color to use for the diagonal border

Returns:int: The index of the color definition
See Also: org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getLeftBorderColor back to summary

getLeftBorderColor	back to summary
public int getLeftBorderColor() get the color to use for the left border Returns:int The index of the color definition See Also `org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)`

public int getLeftBorderColor()

get the color to use for the left border

Returns:int: The index of the color definition
See Also: org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)

getRightBorderColor back to summary

getRightBorderColor	back to summary
public int getRightBorderColor() get the color to use for the right border Returns:int The index of the color definition See Also `org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)`

public int getRightBorderColor()

get the color to use for the right border

Returns:int: The index of the color definition
See Also: org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)

getTopBorderColor back to summary

getTopBorderColor	back to summary
public int getTopBorderColor() get the color to use for the top border Returns:int The index of the color definition See Also `org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)`

public int getTopBorderColor()

get the color to use for the top border

Returns:int: The index of the color definition
See Also: org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)

isBackwardDiagonalOn	back to summary
public boolean isBackwardDiagonalOn() Returns:boolean `true` if backward diagonal is on

isForwardDiagonalOn	back to summary
public boolean isForwardDiagonalOn() Returns:boolean `true` if forward diagonal is on

serialize	back to summary
public int serialize(int offset, byte[] data)

serialize	back to summary
public void serialize(LittleEndianOutput out)

setBackwardDiagonalOn back to summary

public void setBackwardDiagonalOn(boolean on)

Of/off top left to bottom right line

Parameters

on:boolean: - if true - on, otherwise off

setBorderBottom back to summary

public void setBorderBottom(int border)

set the type of border to use for the bottom border of the cell

Parameters

border:int: type

setBorderDiagonal back to summary

public void setBorderDiagonal(int border)

set the type of border to use for the diagonal border of the cell

Parameters

border:int: type

See Also

setBorderLeft back to summary

public void setBorderLeft(int border)

set the type of border to use for the left border of the cell

Parameters

border:int: type

See Also

setBorderRight back to summary

public void setBorderRight(int border)

set the type of border to use for the right border of the cell

Parameters

border:int: type

See Also

setBorderTop back to summary

public void setBorderTop(int border)

set the type of border to use for the top border of the cell

Parameters

border:int: type

See Also

setBottomBorderColor

back to summary

public void setBottomBorderColor(int color)

set the color to use for the bottom border

Parameters

color:int: The index of the color definition

setDiagonalBorderColor

back to summary

public void setDiagonalBorderColor(int color)

set the color to use for the diagonal borders

Parameters

color:int: The index of the color definition

setForwardDiagonalOn back to summary

public void setForwardDiagonalOn(boolean on)

Of/off bottom left to top right line

Parameters

on:boolean: - if true - on, otherwise off

setLeftBorderColor

back to summary

public void setLeftBorderColor(int color)

set the color to use for the left border

Parameters

color:int: The index of the color definition

setRightBorderColor

back to summary

public void setRightBorderColor(int color)

set the color to use for the right border

Parameters

color:int: The index of the color definition

setTopBorderColor

back to summary

public void setTopBorderColor(int color)

set the color to use for the top border

Parameters

color:int: The index of the color definition

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

public final Class BorderFormatting

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail