Class XSSFCellFill
java.lang.Object
org.apache.poi.xssf.usermodel.extensions.XSSFCellFill
This element specifies fill formatting.
A cell fill consists of a background color, foreground color, and pattern to be applied across the cell.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an empty CellFillXSSFCellFill(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTFill fill, IndexedColorMap colorMap) Creates a CellFill from the supplied parts -
Method Summary
Modifier and TypeMethodDescriptionbooleanorg.openxmlformats.schemas.spreadsheetml.x2006.main.CTFillReturns the underlying XML bean.Get the background fill color.Get the foreground fill color.org.openxmlformats.schemas.spreadsheetml.x2006.main.STPatternType.Enumget the fill patterninthashCode()voidsetFillBackgroundColor(int index) Set the background fill color represented as a indexed color value.voidsetFillBackgroundColor(XSSFColor color) Set the background fill color represented as aXSSFColorvalue.voidsetFillForegroundColor(int index) Set the foreground fill color as a indexed color valuevoidsetFillForegroundColor(XSSFColor color) Set the foreground fill color represented as aXSSFColorvalue.voidsetPatternType(org.openxmlformats.schemas.spreadsheetml.x2006.main.STPatternType.Enum patternType) set the fill pattern
-
Constructor Details
-
XSSFCellFill
public XSSFCellFill(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTFill fill, IndexedColorMap colorMap) Creates a CellFill from the supplied parts- Parameters:
fill- - fill
-
XSSFCellFill
public XSSFCellFill()Creates an empty CellFill
-
-
Method Details
-
getFillBackgroundColor
Get the background fill color.- Returns:
- fill color, null if color is not set
-
setFillBackgroundColor
public void setFillBackgroundColor(int index) Set the background fill color represented as a indexed color value.- Parameters:
index-
-
setFillBackgroundColor
Set the background fill color represented as aXSSFColorvalue.- Parameters:
color-
-
getFillForegroundColor
Get the foreground fill color.- Returns:
- XSSFColor - foreground color. null if color is not set
-
setFillForegroundColor
public void setFillForegroundColor(int index) Set the foreground fill color as a indexed color value- Parameters:
index- - the color to use
-
setFillForegroundColor
Set the foreground fill color represented as aXSSFColorvalue.- Parameters:
color- - the color to use
-
getPatternType
public org.openxmlformats.schemas.spreadsheetml.x2006.main.STPatternType.Enum getPatternType()get the fill pattern- Returns:
- fill pattern type. null if fill pattern is not set
-
setPatternType
public void setPatternType(org.openxmlformats.schemas.spreadsheetml.x2006.main.STPatternType.Enum patternType) set the fill pattern- Parameters:
patternType- fill pattern to use
-
getCTFill
Returns the underlying XML bean.- Returns:
- CTFill
-
hashCode
public int hashCode() -
equals
-