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 shortdash-dot borderstatic final shortdash-dot-dot borderstatic final shortdash borderstatic final shorthair-line borderstatic final shortdouble-line borderstatic final shortdot borderstatic final shortMedium borderstatic final shortmedium dash-dot borderstatic final shortmedium dash-dot-dot borderstatic final shortMedium dashed borderstatic final shortNo borderstatic final shortslanted dash-dot borderstatic final shortThick borderstatic final shortThin border -
Constructor Summary
ConstructorsConstructorDescriptionCreates new FontFormatting -
Method Summary
Modifier and TypeMethodDescriptionclone()intget the type of border to use for the bottom border of the cellintget the type of border to use for the diagonal border of the cellintget the type of border to use for the left border of the cellintget the type of border to use for the right border of the cellintget the type of border to use for the top border of the cellintget the color to use for the bottom borderintintget the color to use for the diagonal borderintget the color to use for the left borderintget the color to use for the right borderintget the color to use for the top borderbooleanbooleanintserialize(int offset, byte[] data) voidvoidsetBackwardDiagonalOn(boolean on) Of/off top left to bottom right linevoidsetBorderBottom(int border) set the type of border to use for the bottom border of the cellvoidsetBorderDiagonal(int border) set the type of border to use for the diagonal border of the cellvoidsetBorderLeft(int border) set the type of border to use for the left border of the cellvoidsetBorderRight(int border) set the type of border to use for the right border of the cellvoidsetBorderTop(int border) set the type of border to use for the top border of the cellvoidsetBottomBorderColor(int color) set the color to use for the bottom bordervoidsetDiagonalBorderColor(int color) set the color to use for the diagonal bordersvoidsetForwardDiagonalOn(boolean on) Of/off bottom left to top right linevoidsetLeftBorderColor(int color) set the color to use for the left bordervoidsetRightBorderColor(int color) set the color to use for the right bordervoidsetTopBorderColor(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 -
getBorderLeft
public int getBorderLeft()get the type of border to use for the left border of the cell -
setBorderRight
public void setBorderRight(int border) set the type of border to use for the right border of the cell -
getBorderRight
public int getBorderRight()get the type of border to use for the right border of the cell -
setBorderTop
public void setBorderTop(int border) set the type of border to use for the top border of the cell -
getBorderTop
public int getBorderTop()get the type of border to use for the top border of the cell -
setBorderBottom
public void setBorderBottom(int border) set the type of border to use for the bottom border of the cell -
getBorderBottom
public int getBorderBottom()get the type of border to use for the bottom border of the cell -
setBorderDiagonal
public void setBorderDiagonal(int border) set the type of border to use for the diagonal border of the cell -
getBorderDiagonal
public int getBorderDiagonal()get the type of border to use for the diagonal border of the cell -
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:
trueif forward diagonal is on
-
isBackwardDiagonalOn
public boolean isBackwardDiagonalOn()- Returns:
trueif backward diagonal is on
-
toString
-
clone
-
serialize
public int serialize(int offset, byte[] data) -
serialize
-