Package org.apache.poi.hssf.record.cf
Class BorderFormatting
java.lang.Object
org.apache.poi.hssf.record.cf.BorderFormatting
- All Implemented Interfaces:
Cloneable
Border Formatting Block of the Conditional Formatting Rule Record.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final short
dash-dot borderstatic final short
dash-dot-dot borderstatic final short
dash borderstatic final short
hair-line borderstatic final short
double-line borderstatic final short
dot borderstatic final short
Medium borderstatic final short
medium dash-dot borderstatic final short
medium dash-dot-dot borderstatic final short
Medium dashed borderstatic final short
No borderstatic final short
slanted dash-dot borderstatic final short
Thick borderstatic final short
Thin border -
Constructor Summary
ConstructorsConstructorDescriptionCreates new FontFormatting -
Method Summary
Modifier and TypeMethodDescriptionclone()
int
get the type of border to use for the bottom border of the cellint
get the type of border to use for the diagonal border of the cellint
get the type of border to use for the left border of the cellint
get the type of border to use for the right border of the cellint
get the type of border to use for the top border of the cellint
get the color to use for the bottom borderint
int
get the color to use for the diagonal borderint
get the color to use for the left borderint
get the color to use for the right borderint
get the color to use for the top borderboolean
boolean
int
serialize
(int offset, byte[] data) void
void
setBackwardDiagonalOn
(boolean on) Of/off top left to bottom right linevoid
setBorderBottom
(int border) set the type of border to use for the bottom border of the cellvoid
setBorderDiagonal
(int border) set the type of border to use for the diagonal border of the cellvoid
setBorderLeft
(int border) set the type of border to use for the left border of the cellvoid
setBorderRight
(int border) set the type of border to use for the right border of the cellvoid
setBorderTop
(int border) set the type of border to use for the top border of the cellvoid
setBottomBorderColor
(int color) set the color to use for the bottom bordervoid
setDiagonalBorderColor
(int color) set the color to use for the diagonal bordersvoid
setForwardDiagonalOn
(boolean on) Of/off bottom left to top right linevoid
setLeftBorderColor
(int color) set the color to use for the left bordervoid
setRightBorderColor
(int color) set the color to use for the right bordervoid
setTopBorderColor
(int color) set the color to use for the top bordertoString()
-
Field Details
-
BORDER_NONE
public static final short BORDER_NONENo border- See Also:
-
BORDER_THIN
public static final short BORDER_THINThin border- See Also:
-
BORDER_MEDIUM
public static final short BORDER_MEDIUMMedium border- See Also:
-
BORDER_DASHED
public static final short BORDER_DASHEDdash border- See Also:
-
BORDER_HAIR
public static final short BORDER_HAIRdot border- See Also:
-
BORDER_THICK
public static final short BORDER_THICKThick border- See Also:
-
BORDER_DOUBLE
public static final short BORDER_DOUBLEdouble-line border- See Also:
-
BORDER_DOTTED
public static final short BORDER_DOTTEDhair-line border- See Also:
-
BORDER_MEDIUM_DASHED
public static final short BORDER_MEDIUM_DASHEDMedium dashed border- See Also:
-
BORDER_DASH_DOT
public static final short BORDER_DASH_DOTdash-dot border- See Also:
-
BORDER_MEDIUM_DASH_DOT
public static final short BORDER_MEDIUM_DASH_DOTmedium dash-dot border- See Also:
-
BORDER_DASH_DOT_DOT
public static final short BORDER_DASH_DOT_DOTdash-dot-dot border- See Also:
-
BORDER_MEDIUM_DASH_DOT_DOT
public static final short BORDER_MEDIUM_DASH_DOT_DOTmedium dash-dot-dot border- See Also:
-
BORDER_SLANTED_DASH_DOT
public static final short BORDER_SLANTED_DASH_DOTslanted dash-dot border- See Also:
-
-
Constructor Details
-
BorderFormatting
public BorderFormatting() -
BorderFormatting
Creates new FontFormatting
-
-
Method Details
-
getDataLength
public int getDataLength() -
setBorderLeft
public void setBorderLeft(int border) set the type of border to use for the left border of the cell- Parameters:
border
- type- See Also:
-
getBorderLeft
public int getBorderLeft()get the type of border to use for the left border of the cell- Returns:
- border type
- See Also:
-
setBorderRight
public void setBorderRight(int border) set the type of border to use for the right border of the cell- Parameters:
border
- type- See Also:
-
getBorderRight
public int getBorderRight()get the type of border to use for the right border of the cell- Returns:
- border type
- See Also:
-
setBorderTop
public void setBorderTop(int border) set the type of border to use for the top border of the cell- Parameters:
border
- type- See Also:
-
getBorderTop
public int getBorderTop()get the type of border to use for the top border of the cell- Returns:
- border type
- See Also:
-
setBorderBottom
public void setBorderBottom(int border) set the type of border to use for the bottom border of the cell- Parameters:
border
- type- See Also:
-
getBorderBottom
public int getBorderBottom()get the type of border to use for the bottom border of the cell- Returns:
- border type
- See Also:
-
setBorderDiagonal
public void setBorderDiagonal(int border) set the type of border to use for the diagonal border of the cell- Parameters:
border
- type- See Also:
-
getBorderDiagonal
public int getBorderDiagonal()get the type of border to use for the diagonal border of the cell- Returns:
- border type
- See Also:
-
setLeftBorderColor
public void setLeftBorderColor(int color) set the color to use for the left border- Parameters:
color
- The index of the color definition
-
getLeftBorderColor
public int getLeftBorderColor()get the color to use for the left border- Returns:
- The index of the color definition
- See Also:
-
setRightBorderColor
public void setRightBorderColor(int color) set the color to use for the right border- Parameters:
color
- The index of the color definition
-
getRightBorderColor
public int getRightBorderColor()get the color to use for the right border- Returns:
- The index of the color definition
- See Also:
-
setTopBorderColor
public void setTopBorderColor(int color) set the color to use for the top border- Parameters:
color
- The index of the color definition
-
getTopBorderColor
public int getTopBorderColor()get the color to use for the top border- Returns:
- The index of the color definition
- See Also:
-
setBottomBorderColor
public void setBottomBorderColor(int color) set the color to use for the bottom border- Parameters:
color
- The index of the color definition
-
getBottomBorderColor
public int getBottomBorderColor()get the color to use for the bottom border- Returns:
- The index of the color definition
- See Also:
-
setDiagonalBorderColor
public void setDiagonalBorderColor(int color) set the color to use for the diagonal borders- Parameters:
color
- The index of the color definition
-
getDiagonalBorderColor
public int getDiagonalBorderColor()get the color to use for the diagonal border- Returns:
- The index of the color definition
- See Also:
-
setForwardDiagonalOn
public void setForwardDiagonalOn(boolean on) Of/off bottom left to top right line- Parameters:
on
- - iftrue
- on, otherwise off
-
setBackwardDiagonalOn
public void setBackwardDiagonalOn(boolean on) Of/off top left to bottom right line- Parameters:
on
- - iftrue
- on, otherwise off
-
isForwardDiagonalOn
public boolean isForwardDiagonalOn()- Returns:
true
if forward diagonal is on
-
isBackwardDiagonalOn
public boolean isBackwardDiagonalOn()- Returns:
true
if backward diagonal is on
-
toString
-
clone
-
serialize
public int serialize(int offset, byte[] data) -
serialize
-