public class XSSFCellStyle extends java.lang.Object implements CellStyle, Duplicatable
Constructor and Description |
---|
XSSFCellStyle(int cellXfId,
int cellStyleXfId,
StylesTable stylesSource,
ThemesTable theme)
Creates a Cell Style from the supplied parts
|
XSSFCellStyle(StylesTable stylesSource)
Creates an empty Cell Style
|
Modifier and Type | Method and Description |
---|---|
void |
cloneStyleFrom(CellStyle source)
Clones all the style information from another
XSSFCellStyle, onto this one.
|
XSSFCellStyle |
copy()
Make a copy of this style.
|
boolean |
equals(java.lang.Object o)
Checks is the supplied style is equal to this style
|
HorizontalAlignment |
getAlignment()
get the type of horizontal alignment for the cell
|
BorderStyle |
getBorderBottom()
get the type of border to use for the bottom border of the cell
|
XSSFColor |
getBorderColor(XSSFCellBorder.BorderSide side)
Gets border color
|
BorderStyle |
getBorderLeft()
get the type of border to use for the left border of the cell
|
BorderStyle |
getBorderRight()
get the type of border to use for the right border of the cell
|
BorderStyle |
getBorderTop()
get the type of border to use for the top border of the cell
|
short |
getBottomBorderColor()
Get the color to use for the bottom border
Color is optional. |
XSSFColor |
getBottomBorderXSSFColor()
Get the color to use for the bottom border as a
XSSFColor |
protected XSSFCellAlignment |
getCellAlignment()
get the cellAlignment object to use for manage alignment
|
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTXf |
getCoreXf()
Used so that StylesSource can figure out our location
|
short |
getDataFormat()
Get the index of the number format (numFmt) record used by this cell format.
|
java.lang.String |
getDataFormatString()
Get the contents of the format string, by looking up
the StylesSource
|
short |
getFillBackgroundColor()
Get the background fill color.
|
XSSFColor |
getFillBackgroundColorColor()
Gets the color object representing the current
background fill, resolving indexes using
the supplied workbook.
|
XSSFColor |
getFillBackgroundXSSFColor()
Get the background fill color.
|
short |
getFillForegroundColor()
Get the foreground fill color.
|
XSSFColor |
getFillForegroundColorColor()
Gets the color object representing the current
foreground fill, resolving indexes using
the supplied workbook.
|
XSSFColor |
getFillForegroundXSSFColor()
Get the foreground fill color.
|
FillPatternType |
getFillPattern()
Get the fill pattern
|
XSSFFont |
getFont()
Gets the font for this style
|
int |
getFontIndex()
Gets the index of the font for this style
|
int |
getFontIndexAsInt()
Deprecated.
use
getFontIndex() instead |
boolean |
getHidden()
Get whether the cell's using this style are to be hidden
|
short |
getIndention()
Get the number of spaces to indent the text in the cell
|
short |
getIndex()
Get the index within the StylesTable (sequence within the collection of CTXf elements)
|
short |
getLeftBorderColor()
Get the color to use for the left border
|
XSSFColor |
getLeftBorderXSSFColor()
Get the color to use for the left border
|
boolean |
getLocked()
Get whether the cell's using this style are locked
|
boolean |
getQuotePrefixed()
Is "Quote Prefix" or "123 Prefix" enabled for the cell?
|
ReadingOrder |
getReadingOrder()
Get reading order of the cell
|
short |
getRightBorderColor()
Get the color to use for the right border
|
XSSFColor |
getRightBorderXSSFColor()
Get the color to use for the right border
|
short |
getRotation()
Get the degree of rotation for the text in the cell
|
boolean |
getShrinkToFit()
Should the Cell be auto-sized by Excel to shrink
it to fit if this text is too long?
|
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTXf |
getStyleXf()
Used so that StylesSource can figure out our location
|
short |
getTopBorderColor()
Get the color to use for the top border
|
XSSFColor |
getTopBorderXSSFColor()
Get the color to use for the top border
|
protected int |
getUIndex()
Workaround for places where we need to support more than 32767 cell styles, ideally
the main getIndex() and others would return int, not short, but that would affect some
public APIs
|
VerticalAlignment |
getVerticalAlignment()
get the type of vertical alignment for the cell
|
boolean |
getWrapText()
Whether the text should be wrapped
|
int |
hashCode()
Returns a hash code value for the object.
|
void |
setAlignment(HorizontalAlignment align)
Set the type of horizontal alignment for the cell
|
void |
setBorderBottom(BorderStyle border)
Set the type of border to use for the bottom border of the cell
|
void |
setBorderColor(XSSFCellBorder.BorderSide side,
XSSFColor color)
Set the color to use for the selected border
|
void |
setBorderLeft(BorderStyle border)
Set the type of border to use for the left border of the cell
|
void |
setBorderRight(BorderStyle border)
Set the type of border to use for the right border of the cell
|
void |
setBorderTop(BorderStyle border)
Set the type of border to use for the top border of the cell
|
void |
setBottomBorderColor(short color)
Set the color to use for the bottom border
|
void |
setBottomBorderColor(XSSFColor color)
Set the color to use for the bottom border
|
void |
setDataFormat(int fmt)
Set the index of a data format
|
void |
setDataFormat(short fmt)
Set the index of a data format
|
void |
setFillBackgroundColor(Color color)
Set the background fill color represented as a
Color value. |
void |
setFillBackgroundColor(short bg)
Set the background fill color represented as a indexed color value.
|
void |
setFillBackgroundColor(XSSFColor color)
Set the background fill color represented as a
XSSFColor value. |
void |
setFillForegroundColor(Color color)
Set the foreground fill color represented as a
Color value. |
void |
setFillForegroundColor(short fg)
Set the foreground fill color as a indexed color value
Note: Ensure Foreground color is set prior to background color. |
void |
setFillForegroundColor(XSSFColor color)
Set the foreground fill color represented as a
XSSFColor value. |
void |
setFillPattern(FillPatternType pattern)
This element is used to specify cell fill information for pattern and solid color cell fills.
|
void |
setFont(Font font)
Set the font for this style
|
void |
setHidden(boolean hidden)
Set the cell's using this style to be hidden
|
void |
setIndention(short indent)
Set the number of spaces to indent the text in the cell
|
void |
setLeftBorderColor(short color)
Set the color to use for the left border as a indexed color value
|
void |
setLeftBorderColor(XSSFColor color)
Set the color to use for the left border as a
XSSFColor value |
void |
setLocked(boolean locked)
Set the cell's using this style to be locked
|
void |
setQuotePrefixed(boolean quotePrefix)
Turn on or off "Quote Prefix" or "123 Prefix" for the style,
which is used to tell Excel that the thing which looks like
a number or a formula shouldn't be treated as on.
|
void |
setReadingOrder(ReadingOrder order)
Set reading order for the cell
|
void |
setRightBorderColor(short color)
Set the color to use for the right border
|
void |
setRightBorderColor(XSSFColor color)
Set the color to use for the right border as a
XSSFColor value |
void |
setRotation(short rotation)
Set the degree of rotation for the text in the cell
|
void |
setShrinkToFit(boolean shrinkToFit)
Controls if the Cell should be auto-sized
to shrink to fit if the text is too long
|
void |
setTopBorderColor(short color)
Set the color to use for the top border
|
void |
setTopBorderColor(XSSFColor color)
Set the color to use for the top border as a
XSSFColor value |
void |
setVerticalAlignment(VerticalAlignment align)
Set the type of vertical alignment for the cell
|
void |
setWrapText(boolean wrapped)
Set whether the text should be wrapped.
|
void |
verifyBelongsToStylesSource(StylesTable src)
Verifies that this style belongs to the supplied Workbook
Styles Source.
|
public XSSFCellStyle(int cellXfId, int cellStyleXfId, StylesTable stylesSource, ThemesTable theme)
cellXfId
- The main XF for the cell. Must be a valid 0-based index into the XF tablecellStyleXfId
- Optional, style xf. A value of -1
means no xf.stylesSource
- Styles Source to work offpublic XSSFCellStyle(StylesTable stylesSource)
@Internal public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTXf getCoreXf()
@Internal public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTXf getStyleXf()
public void verifyBelongsToStylesSource(StylesTable src)
java.lang.IllegalArgumentException
- if there's a workbook mis-matchpublic void cloneStyleFrom(CellStyle source)
cloneStyleFrom
in interface CellStyle
public HorizontalAlignment getAlignment()
CellStyle
getAlignment
in interface CellStyle
public BorderStyle getBorderBottom()
CellStyle
getBorderBottom
in interface CellStyle
public BorderStyle getBorderLeft()
CellStyle
getBorderLeft
in interface CellStyle
public BorderStyle getBorderRight()
CellStyle
getBorderRight
in interface CellStyle
public BorderStyle getBorderTop()
CellStyle
getBorderTop
in interface CellStyle
public short getBottomBorderColor()
getBottomBorderColor
in interface CellStyle
IndexedColors.AUTOMATIC
IndexedColors
public XSSFColor getBottomBorderXSSFColor()
XSSFColor
null
if not setpublic short getDataFormat()
getDataFormat
in interface CellStyle
DataFormat
public java.lang.String getDataFormatString()
getDataFormatString
in interface CellStyle
public short getFillBackgroundColor()
Note - many cells are actually filled with a foreground
fill, not a background fill - see getFillForegroundColor()
getFillBackgroundColor
in interface CellStyle
IndexedColors.AUTOMATIC
IndexedColors
public XSSFColor getFillBackgroundColorColor()
CellStyle
getFillBackgroundColorColor
in interface CellStyle
public XSSFColor getFillBackgroundXSSFColor()
Note - many cells are actually filled with a foreground
fill, not a background fill - see getFillForegroundColor()
null
if not setXSSFColor.getRGB()
public short getFillForegroundColor()
Many cells are filled with this, instead of a
background color (getFillBackgroundColor()
)
getFillForegroundColor
in interface CellStyle
IndexedColors.AUTOMATIC
IndexedColors
public XSSFColor getFillForegroundColorColor()
CellStyle
getFillForegroundColorColor
in interface CellStyle
public XSSFColor getFillForegroundXSSFColor()
null
if not setpublic FillPatternType getFillPattern()
CellStyle
getFillPattern
in interface CellStyle
FillPatternType.NO_FILL
public XSSFFont getFont()
public int getFontIndex()
getFontIndex
in interface CellStyle
XSSFWorkbook.getFontAt(int)
@Deprecated @Removal(version="6.0.0") public int getFontIndexAsInt()
getFontIndex()
insteadgetFontIndexAsInt
in interface CellStyle
XSSFWorkbook.getFontAt(int)
public boolean getHidden()
public short getIndention()
getIndention
in interface CellStyle
public short getIndex()
protected int getUIndex()
public short getLeftBorderColor()
getLeftBorderColor
in interface CellStyle
IndexedColors.BLACK
IndexedColors
public XSSFColor getLeftBorderXSSFColor()
null
if not setIndexedColors
public boolean getLocked()
public boolean getQuotePrefixed()
getQuotePrefixed
in interface CellStyle
public short getRightBorderColor()
getRightBorderColor
in interface CellStyle
IndexedColors.BLACK
IndexedColors
public XSSFColor getRightBorderXSSFColor()
null
if not setpublic short getRotation()
Expressed in degrees. Values range from 0 to 180. The first letter of
the text is considered the center-point of the arc.
For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the
horizon is calculated as:
[degrees below horizon] = 90 - textRotation.
getRotation
in interface CellStyle
public boolean getShrinkToFit()
CellStyle
getShrinkToFit
in interface CellStyle
public short getTopBorderColor()
getTopBorderColor
in interface CellStyle
IndexedColors.BLACK
IndexedColors
public XSSFColor getTopBorderXSSFColor()
null
if not setpublic VerticalAlignment getVerticalAlignment()
CellStyle
getVerticalAlignment
in interface CellStyle
public boolean getWrapText()
getWrapText
in interface CellStyle
public void setAlignment(HorizontalAlignment align)
setAlignment
in interface CellStyle
align
- - the type of alignmentpublic void setBorderBottom(BorderStyle border)
setBorderBottom
in interface CellStyle
border
- - type of border to useBorderStyle
public void setBorderLeft(BorderStyle border)
setBorderLeft
in interface CellStyle
border
- the type of border to usepublic void setBorderRight(BorderStyle border)
setBorderRight
in interface CellStyle
border
- the type of border to usepublic void setBorderTop(BorderStyle border)
setBorderTop
in interface CellStyle
border
- the type of border to usepublic void setBottomBorderColor(short color)
setBottomBorderColor
in interface CellStyle
color
- the index of the color definitionIndexedColors
public void setBottomBorderColor(XSSFColor color)
color
- the color to use, null means no colorpublic void setDataFormat(short fmt)
setDataFormat
in interface CellStyle
fmt
- the index of a data formatDataFormat
public void setDataFormat(int fmt)
fmt
- the index of a data formatpublic void setFillBackgroundColor(XSSFColor color)
XSSFColor
value.
For example:
cs.setFillPattern(XSSFCellStyle.FINE_DOTS ); cs.setFillBackgroundXSSFColor(new XSSFColor(java.awt.Color.RED));optionally a Foreground and background fill can be applied: Note: Ensure Foreground color is set prior to background
cs.setFillPattern(XSSFCellStyle.FINE_DOTS ); cs.setFillForegroundColor(new XSSFColor(java.awt.Color.BLUE)); cs.setFillBackgroundColor(new XSSFColor(java.awt.Color.GREEN));or, for the special case of SOLID_FILL:
cs.setFillPattern(XSSFCellStyle.SOLID_FOREGROUND ); cs.setFillForegroundColor(new XSSFColor(java.awt.Color.GREEN));It is necessary to set the fill style in order for the color to be shown in the cell.
color
- - the color to usepublic void setFillBackgroundColor(Color color)
Color
value.
setFillBackgroundColor
in interface CellStyle
color
- org.apache.poi.ss.usermodel.Color to setjava.lang.IllegalArgumentException
- if you provide a Color
instance that is not a XSSFColor
public void setFillBackgroundColor(short bg)
For example:
cs.setFillPattern(XSSFCellStyle.FINE_DOTS ); cs.setFillBackgroundXSSFColor(IndexedColors.RED.getIndex());optionally a Foreground and background fill can be applied: Note: Ensure Foreground color is set prior to background
cs.setFillPattern(XSSFCellStyle.FINE_DOTS ); cs.setFillForegroundColor(IndexedColors.BLUE.getIndex()); cs.setFillBackgroundColor(IndexedColors.RED.getIndex());or, for the special case of SOLID_FILL:
cs.setFillPattern(XSSFCellStyle.SOLID_FOREGROUND ); cs.setFillForegroundColor(IndexedColors.RED.getIndex());It is necessary to set the fill style in order for the color to be shown in the cell.
setFillBackgroundColor
in interface CellStyle
bg
- - the color to useIndexedColors
public void setFillForegroundColor(XSSFColor color)
XSSFColor
value.
color
- the color to use)
public void setFillForegroundColor(Color color)
Color
value.
setFillForegroundColor
in interface CellStyle
color
- the color to usejava.lang.IllegalArgumentException
- if you provide a Color
instance that is not a XSSFColor
public void setFillForegroundColor(short fg)
setFillForegroundColor
in interface CellStyle
fg
- the color to useIndexedColors
public void setReadingOrder(ReadingOrder order)
order
- - the reading orderpublic ReadingOrder getReadingOrder()
public void setFillPattern(FillPatternType pattern)
setFillPattern
in interface CellStyle
pattern
- the fill pattern to usesetFillBackgroundColor(XSSFColor)
,
setFillForegroundColor(XSSFColor)
,
FillPatternType
public void setFont(Font font)
setFont
in interface CellStyle
font
- a font object created or retrieved from the XSSFWorkbook objectXSSFWorkbook.createFont()
,
XSSFWorkbook.getFontAt(int)
public void setHidden(boolean hidden)
public void setIndention(short indent)
setIndention
in interface CellStyle
indent
- - number of spacespublic void setLeftBorderColor(short color)
setLeftBorderColor
in interface CellStyle
color
- the index of the color definitionIndexedColors
public void setLeftBorderColor(XSSFColor color)
XSSFColor
valuecolor
- the color to usepublic void setLocked(boolean locked)
public void setQuotePrefixed(boolean quotePrefix)
setQuotePrefixed
in interface CellStyle
public void setRightBorderColor(short color)
setRightBorderColor
in interface CellStyle
color
- the index of the color definitionIndexedColors
public void setRightBorderColor(XSSFColor color)
XSSFColor
valuecolor
- the color to usepublic void setRotation(short rotation)
Expressed in degrees. Values range from 0 to 180. The first letter of
the text is considered the center-point of the arc.
For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the
horizon is calculated as:
[degrees below horizon] = 90 - textRotation.
setRotation
in interface CellStyle
rotation
- - the rotation degrees (between 0 and 180 degrees)public void setTopBorderColor(short color)
setTopBorderColor
in interface CellStyle
color
- the index of the color definitionIndexedColors
public void setTopBorderColor(XSSFColor color)
XSSFColor
valuecolor
- the color to usepublic void setVerticalAlignment(VerticalAlignment align)
setVerticalAlignment
in interface CellStyle
align
- - the type of alignmentpublic void setWrapText(boolean wrapped)
Setting this flag to true
make all content visible
within a cell by displaying it on multiple lines
setWrapText
in interface CellStyle
wrapped
- a boolean value indicating if the text in a cell should be line-wrapped within the cell.public XSSFColor getBorderColor(XSSFCellBorder.BorderSide side)
side
- the border sidepublic void setBorderColor(XSSFCellBorder.BorderSide side, XSSFColor color)
side
- - where to apply the color definitioncolor
- - the color to usepublic void setShrinkToFit(boolean shrinkToFit)
CellStyle
setShrinkToFit
in interface CellStyle
protected XSSFCellAlignment getCellAlignment()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- the style to checkpublic XSSFCellStyle copy()
copy
in interface Duplicatable
Copyright 2022 The Apache Software Foundation or its licensors, as applicable.