org.zkoss.poi.xssf.usermodel

Class XSSFCellStyle

java.lang.Object

org.zkoss.poi.xssf.usermodel.XSSFCellStyle

All Implemented Interfaces:

CellStyle

public class XSSFCellStyle
extends java.lang.Object
implements CellStyle

High level representation of the the possible formatting information for the contents of the cells on a sheet in a SpreadsheetML document.

See Also:

XSSFWorkbook.createCellStyle(), XSSFWorkbook.getCellStyleAt(short), XSSFCell.setCellStyle(org.zkoss.poi.ss.usermodel.CellStyle)

Field Summary

Fields inherited from interface org.zkoss.poi.ss.usermodel.CellStyle

ALIGN_CENTER, ALIGN_CENTER_SELECTION, ALIGN_FILL, ALIGN_GENERAL, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_RIGHT, ALT_BARS, BIG_SPOTS, BORDER_DASH_DOT, BORDER_DASH_DOT_DOT, BORDER_DASHED, BORDER_DOTTED, BORDER_DOUBLE, BORDER_HAIR, BORDER_MEDIUM, BORDER_MEDIUM_DASH_DOT, BORDER_MEDIUM_DASH_DOT_DOT, BORDER_MEDIUM_DASHED, BORDER_NONE, BORDER_SLANTED_DASH_DOT, BORDER_THICK, BORDER_THIN, BRICKS, DIAMONDS, FINE_DOTS, LEAST_DOTS, LESS_DOTS, NO_FILL, SOLID_FOREGROUND, SPARSE_DOTS, SQUARES, THICK_BACKWARD_DIAG, THICK_FORWARD_DIAG, THICK_HORZ_BANDS, THICK_VERT_BANDS, THIN_BACKWARD_DIAG, THIN_FORWARD_DIAG, THIN_HORZ_BANDS, THIN_VERT_BANDS, VERTICAL_BOTTOM, VERTICAL_CENTER, VERTICAL_JUSTIFY, VERTICAL_TOP

Constructor Summary

Constructors

Constructor and Description
XSSFCellStyle(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTXf cellStyleXf, StylesTable stylesSource, ThemesTable theme)
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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Make a copy of this style.
void	cloneStyleFrom(CellStyle source) Clones all the style information from another XSSFCellStyle, onto this one.
boolean	equals(java.lang.Object o) Checks is the supplied style is equal to this style
short	getAlignment() Get the type of horizontal alignment for the cell
HorizontalAlignment	getAlignmentEnum() Get the type of horizontal alignment for the cell
short	getBorderBottom() Get the type of border to use for the bottom border of the cell
BorderStyle	getBorderBottomEnum() Get the type of border to use for the bottom border of the cell
XSSFColor	getBorderColor(XSSFCellBorder.BorderSide side) Gets border color
short	getBorderDiagonal() get the type of border to use for the diagonal border of the cell
short	getBorderLeft() Get the type of border to use for the left border of the cell
BorderStyle	getBorderLeftEnum() Get the type of border to use for the left border of the cell
short	getBorderRight() Get the type of border to use for the right border of the cell
BorderStyle	getBorderRightEnum() Get the type of border to use for the right border of the cell
short	getBorderTop() Get the type of border to use for the top border of the cell
BorderStyle	getBorderTopEnum() 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	getBottomBorderColorColor()
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	getCellXf()
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	getDiagonalBorderColor() get the color to use for the diagonal border
Color	getDiagonalBorderColorColor()
XSSFColor	getDiagonalBorderXSSFColor() Get the color to use for the left border
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.
short	getFillPattern() Get the fill pattern
FillPatternType	getFillPatternEnum() Get the fill pattern
XSSFFont	getFont() Gets the font for this style
short	getFontIndex() Gets the index of the font for this style
boolean	getHidden() Get whether the cell's using this style are to be hidden
XSSFColor	getHorizontalBorderXSSFColor() Get the color to use for the horizontal border
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	getLeftBorderColorColor()
XSSFColor	getLeftBorderXSSFColor() Get the color to use for the left border
boolean	getLocked() Get whether the cell's using this style are locked
java.lang.String	getRawDataFormatString() Get the raw data format string that are not transfered by ZSS Context Locale
short	getRightBorderColor() Get the color to use for the right border
XSSFColor	getRightBorderColorColor()
XSSFColor	getRightBorderXSSFColor() Get the color to use for the right border
short	getRotation() Get the degree of rotation for the text in the cell Expressed in degrees.
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	getTopBorderColorColor()
XSSFColor	getTopBorderXSSFColor() Get the color to use for the top border
short	getVerticalAlignment() Get the type of vertical alignment for the cell
VerticalAlignment	getVerticalAlignmentEnum() Get the type of vertical alignment for the cell
XSSFColor	getVerticalBorderXSSFColor() Get the color to use for the left border
boolean	getWrapText() Whether the text should be wrapped
int	hashCode() Returns a hash code value for the object.
boolean	isBuiltinDataFormat() Check if the data format is build in format
boolean	isShowDiagonalDownBorder() Whether show diagonalDown diagonal border
boolean	isShowDiagonalUpBorder() Whether show diagonalUp diagonal border
void	setAlignment(HorizontalAlignment align) Set the type of horizontal alignment for the cell
void	setAlignment(short align) Set the type of horizontal alignment for the cell
void	setBorder(short left, Color leftColor, short top, Color topColor, short right, Color rightColor, short bottom, Color bottomColor)
void	setBorder(short left, Color leftColor, short top, Color topColor, short right, Color rightColor, short bottom, Color bottomColor, short diagonal, Color diagonalColor, short horizontal, Color horizontalColor, short vertical, Color verticalColor, boolean diaUp, boolean diaDown)
void	setBorderBottom(BorderStyle border) Set the type of border to use for the bottom border of the cell
void	setBorderBottom(short 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	setBorderDiagonal(short border) set the type of border to use for the diagonal border of the cell
void	setBorderLeft(BorderStyle border) Set the type of border to use for the left border of the cell
void	setBorderLeft(short 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	setBorderRight(short 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	setBorderTop(short 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	setCellAlignment(short hAlign, short vAlign, boolean wrapText)
void	setDataFormat(short fmt) Set the index of a data format
void	setDefaultCellAlignment(short hAlign, short vAlign, boolean wrapText)
void	setDefaultProtection(boolean locked, boolean hidden)
void	setDiagonalBorderColor(short color) set the color to use for the diagonal border
void	setDiagonalBorderColor(XSSFColor color) Set the color to use for the left border as a XSSFColor value
void	setFill(Color fillColor, Color backColor, short patternType)
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(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 ptrn) This element is used to specify cell fill information for pattern and solid color cell fills.
void	setFillPattern(short fp) 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	setFontColorColor(Color color)
void	setHidden(boolean hidden) Set the cell's using this style to be hidden
void	setHorizontalBorderColor(XSSFColor color) Set the color to use for the left border as a XSSFColor value
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	setProtection(boolean locked, boolean hidden)
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 Expressed in degrees.
void	setShowDiagonalDownBorder(boolean down) Whether show diagonalDown diagonal border
void	setShowDiagonalUpBorder(boolean up) Whether show diagonalUp diagonal border
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(short align) Set the type of vertical alignment for the cell
void	setVerticalAlignment(VerticalAlignment align) Set the type of vertical alignment for the cell
void	setVerticalBorderColor(XSSFColor color) Set the color to use for the left border as a XSSFColor value
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.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XSSFCellStyle

public XSSFCellStyle(int cellXfId,
             int cellStyleXfId,
             StylesTable stylesSource,
             ThemesTable theme)

Creates a Cell Style from the supplied parts

Parameters:

cellXfId - The main XF for the cell. Must be a valid 0-based index into the XF table

cellStyleXfId - Optional, style xf. A value of -1 means no xf.

stylesSource - Styles Source to work off

XSSFCellStyle

public XSSFCellStyle(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTXf cellStyleXf,
             StylesTable stylesSource,
             ThemesTable theme)

XSSFCellStyle

public XSSFCellStyle(StylesTable stylesSource)

Creates an empty Cell Style

Method Detail

getCoreXf

@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTXf getCoreXf()

Used so that StylesSource can figure out our location

getStyleXf

@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTXf getStyleXf()

Used so that StylesSource can figure out our location

verifyBelongsToStylesSource

public void verifyBelongsToStylesSource(StylesTable src)

Verifies that this style belongs to the supplied Workbook Styles Source. Will throw an exception if it belongs to a different one. This is normally called when trying to assign a style to a cell, to ensure the cell and the style are from the same workbook (if they're not, it won't work)

Throws:

java.lang.IllegalArgumentException - if there's a workbook mis-match

cloneStyleFrom

public void cloneStyleFrom(CellStyle source)

Clones all the style information from another XSSFCellStyle, onto this one. This XSSFCellStyle will then have all the same properties as the source, but the two may be edited independently. Any stylings on this XSSFCellStyle will be lost! The source XSSFCellStyle could be from another XSSFWorkbook if you like. This allows you to copy styles from one XSSFWorkbook to another.

Specified by:

cloneStyleFrom in interface CellStyle

getAlignment

public short getAlignment()

Get the type of horizontal alignment for the cell

Specified by:

getAlignment in interface CellStyle

Returns:

short - the type of alignment

See Also:

CellStyle.ALIGN_GENERAL, CellStyle.ALIGN_LEFT, CellStyle.ALIGN_CENTER, CellStyle.ALIGN_RIGHT, CellStyle.ALIGN_FILL, CellStyle.ALIGN_JUSTIFY, CellStyle.ALIGN_CENTER_SELECTION

getAlignmentEnum

public HorizontalAlignment getAlignmentEnum()

Get the type of horizontal alignment for the cell

Returns:

HorizontalAlignment - the type of alignment

See Also:

HorizontalAlignment

getBorderBottom

public short getBorderBottom()

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

Specified by:

getBorderBottom in interface CellStyle

Returns:

short - border type

See Also:

CellStyle.BORDER_NONE, CellStyle.BORDER_THIN, CellStyle.BORDER_MEDIUM, CellStyle.BORDER_DASHED, CellStyle.BORDER_DOTTED, CellStyle.BORDER_THICK, CellStyle.BORDER_DOUBLE, CellStyle.BORDER_HAIR, CellStyle.BORDER_MEDIUM_DASHED, CellStyle.BORDER_DASH_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT, CellStyle.BORDER_DASH_DOT_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT_DOT, CellStyle.BORDER_SLANTED_DASH_DOT

getBorderBottomEnum

public BorderStyle getBorderBottomEnum()

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

Returns:

border type as Java enum

See Also:

BorderStyle

getBorderLeft

public short getBorderLeft()

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

Specified by:

getBorderLeft in interface CellStyle

Returns:

short - border type, default value is CellStyle.BORDER_NONE

See Also:

CellStyle.BORDER_NONE, CellStyle.BORDER_THIN, CellStyle.BORDER_MEDIUM, CellStyle.BORDER_DASHED, CellStyle.BORDER_DOTTED, CellStyle.BORDER_THICK, CellStyle.BORDER_DOUBLE, CellStyle.BORDER_HAIR, CellStyle.BORDER_MEDIUM_DASHED, CellStyle.BORDER_DASH_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT, CellStyle.BORDER_DASH_DOT_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT_DOT, CellStyle.BORDER_SLANTED_DASH_DOT

getBorderLeftEnum

public BorderStyle getBorderLeftEnum()

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

Returns:

border type, default value is BorderStyle.NONE

getBorderRight

public short getBorderRight()

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

Specified by:

getBorderRight in interface CellStyle

Returns:

short - border type, default value is CellStyle.BORDER_NONE

See Also:

CellStyle.BORDER_NONE, CellStyle.BORDER_THIN, CellStyle.BORDER_MEDIUM, CellStyle.BORDER_DASHED, CellStyle.BORDER_DOTTED, CellStyle.BORDER_THICK, CellStyle.BORDER_DOUBLE, CellStyle.BORDER_HAIR, CellStyle.BORDER_MEDIUM_DASHED, CellStyle.BORDER_DASH_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT, CellStyle.BORDER_DASH_DOT_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT_DOT, CellStyle.BORDER_SLANTED_DASH_DOT

getBorderRightEnum

public BorderStyle getBorderRightEnum()

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

Returns:

border type, default value is BorderStyle.NONE

getBorderTop

public short getBorderTop()

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

Specified by:

getBorderTop in interface CellStyle

Returns:

short - border type, default value is CellStyle.BORDER_NONE

See Also:

CellStyle.BORDER_NONE, CellStyle.BORDER_THIN, CellStyle.BORDER_MEDIUM, CellStyle.BORDER_DASHED, CellStyle.BORDER_DOTTED, #BORDER_THICK, CellStyle.BORDER_DOUBLE, CellStyle.BORDER_HAIR, CellStyle.BORDER_MEDIUM_DASHED, CellStyle.BORDER_DASH_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT, CellStyle.BORDER_DASH_DOT_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT_DOT, CellStyle.BORDER_SLANTED_DASH_DOT

getBorderTopEnum

public BorderStyle getBorderTopEnum()

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

Returns:

border type, default value is BorderStyle.NONE

getBottomBorderColor

public short getBottomBorderColor()

Get the color to use for the bottom border
Color is optional. When missing, IndexedColors.AUTOMATIC is implied.

Specified by:

getBottomBorderColor in interface CellStyle

Returns:

the index of the color definition, default value is IndexedColors.AUTOMATIC

See Also:

IndexedColors

getBottomBorderXSSFColor

public XSSFColor getBottomBorderXSSFColor()

Get the color to use for the bottom border as a XSSFColor

Returns:

the used color or null if not set

getDataFormat

public short getDataFormat()

Get the index of the number format (numFmt) record used by this cell format.

Specified by:

getDataFormat in interface CellStyle

Returns:

the index of the number format

See Also:

DataFormat

getDataFormatString

public java.lang.String getDataFormatString()

Get the contents of the format string, by looking up the StylesSource

Specified by:

getDataFormatString in interface CellStyle

Returns:

the number format string

getRawDataFormatString

public java.lang.String getRawDataFormatString()

Description copied from interface: CellStyle

Get the raw data format string that are not transfered by ZSS Context Locale

Specified by:

getRawDataFormatString in interface CellStyle

Returns:

isBuiltinDataFormat

public boolean isBuiltinDataFormat()

Description copied from interface: CellStyle

Check if the data format is build in format

Specified by:

isBuiltinDataFormat in interface CellStyle

Returns:

getFillBackgroundColor

public short getFillBackgroundColor()

Get the background fill color.

Note - many cells are actually filled with a foreground fill, not a background fill - see getFillForegroundColor()

Specified by:

getFillBackgroundColor in interface CellStyle

Returns:

fill color, default value is IndexedColors.AUTOMATIC

See Also:

IndexedColors

getFillBackgroundColorColor

public XSSFColor getFillBackgroundColorColor()

Description copied from interface: CellStyle

Gets the color object representing the current background fill, resolving indexes using the supplied workbook. This will work for both indexed and rgb defined colors.

Specified by:

getFillBackgroundColorColor in interface CellStyle

getFillBackgroundXSSFColor

public XSSFColor getFillBackgroundXSSFColor()

Get the background fill color.

Note - many cells are actually filled with a foreground fill, not a background fill - see getFillForegroundColor()

Returns:

XSSFColor - fill color or null if not set

See Also:

XSSFColor.getRgb()

getFillForegroundColor

public short getFillForegroundColor()

Get the foreground fill color.

Many cells are filled with this, instead of a background color (getFillBackgroundColor())

Specified by:

getFillForegroundColor in interface CellStyle

Returns:

fill color, default value is IndexedColors.AUTOMATIC

See Also:

IndexedColors

getFillForegroundColorColor

public XSSFColor getFillForegroundColorColor()

Description copied from interface: CellStyle

Gets the color object representing the current foreground fill, resolving indexes using the supplied workbook. This will work for both indexed and rgb defined colors.

Specified by:

getFillForegroundColorColor in interface CellStyle

getFillForegroundXSSFColor

public XSSFColor getFillForegroundXSSFColor()

Get the foreground fill color.

Returns:

XSSFColor - fill color or null if not set

getFillPattern

public short getFillPattern()

Get the fill pattern

Specified by:

getFillPattern in interface CellStyle

Returns:

fill pattern, default value is CellStyle.NO_FILL

See Also:

CellStyle.NO_FILL, CellStyle.SOLID_FOREGROUND, CellStyle.FINE_DOTS, CellStyle.ALT_BARS, CellStyle.SPARSE_DOTS, CellStyle.THICK_HORZ_BANDS, CellStyle.THICK_VERT_BANDS, CellStyle.THICK_BACKWARD_DIAG, CellStyle.THICK_FORWARD_DIAG, CellStyle.BIG_SPOTS, CellStyle.BRICKS, CellStyle.THIN_HORZ_BANDS, CellStyle.THIN_VERT_BANDS, CellStyle.THIN_BACKWARD_DIAG, CellStyle.THIN_FORWARD_DIAG, CellStyle.SQUARES, CellStyle.DIAMONDS

getFillPatternEnum

public FillPatternType getFillPatternEnum()

Get the fill pattern

Returns:

the fill pattern, default value is FillPatternType.NO_FILL

getFont

public XSSFFont getFont()

Gets the font for this style

Returns:

Font - font

getFontIndex

public short getFontIndex()

Gets the index of the font for this style

Specified by:

getFontIndex in interface CellStyle

Returns:

short - font index

See Also:

XSSFWorkbook.getFontAt(short)

getHidden

public boolean getHidden()

Get whether the cell's using this style are to be hidden

Specified by:

getHidden in interface CellStyle

Returns:

boolean - whether the cell using this style is hidden

getIndention

public short getIndention()

Get the number of spaces to indent the text in the cell

Specified by:

getIndention in interface CellStyle

Returns:

indent - number of spaces

getIndex

public short getIndex()

Get the index within the StylesTable (sequence within the collection of CTXf elements)

Specified by:

getIndex in interface CellStyle

Returns:

unique index number of the underlying record this style represents

getLeftBorderColor

public short getLeftBorderColor()

Get the color to use for the left border

Specified by:

getLeftBorderColor in interface CellStyle

Returns:

the index of the color definition, default value is IndexedColors.BLACK

See Also:

IndexedColors

getLeftBorderXSSFColor

public XSSFColor getLeftBorderXSSFColor()

Get the color to use for the left border

Returns:

the index of the color definition or null if not set

See Also:

IndexedColors

getLocked

public boolean getLocked()

Get whether the cell's using this style are locked

Specified by:

getLocked in interface CellStyle

Returns:

whether the cell using this style are locked

getRightBorderColor

public short getRightBorderColor()

Get the color to use for the right border

Specified by:

getRightBorderColor in interface CellStyle

Returns:

the index of the color definition, default value is IndexedColors.BLACK

See Also:

IndexedColors

getRightBorderXSSFColor

public XSSFColor getRightBorderXSSFColor()

Get the color to use for the right border

Returns:

the used color or null if not set

getRotation

public short getRotation()

Get the degree of rotation for the text in the cell

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.

Specified by:

getRotation in interface CellStyle

Returns:

rotation degrees (between 0 and 180 degrees)

getTopBorderColor

public short getTopBorderColor()

Get the color to use for the top border

Specified by:

getTopBorderColor in interface CellStyle

Returns:

the index of the color definition, default value is IndexedColors.BLACK

See Also:

IndexedColors

getTopBorderXSSFColor

public XSSFColor getTopBorderXSSFColor()

Get the color to use for the top border

Returns:

the used color or null if not set

getVerticalAlignment

public short getVerticalAlignment()

Get the type of vertical alignment for the cell

Specified by:

getVerticalAlignment in interface CellStyle

Returns:

align the type of alignment, default value is CellStyle.VERTICAL_BOTTOM

See Also:

CellStyle.VERTICAL_TOP, CellStyle.VERTICAL_CENTER, CellStyle.VERTICAL_BOTTOM, CellStyle.VERTICAL_JUSTIFY

getVerticalAlignmentEnum

public VerticalAlignment getVerticalAlignmentEnum()

Get the type of vertical alignment for the cell

Returns:

the type of alignment, default value is VerticalAlignment.BOTTOM

See Also:

VerticalAlignment

getWrapText

public boolean getWrapText()

Whether the text should be wrapped

Specified by:

getWrapText in interface CellStyle

Returns:

a boolean value indicating if the text in a cell should be line-wrapped within the cell.

setAlignment

public void setAlignment(short align)

Set the type of horizontal alignment for the cell

Specified by:

setAlignment in interface CellStyle

Parameters:

align - - the type of alignment

See Also:

CellStyle.ALIGN_GENERAL, CellStyle.ALIGN_LEFT, CellStyle.ALIGN_CENTER, CellStyle.ALIGN_RIGHT, CellStyle.ALIGN_FILL, CellStyle.ALIGN_JUSTIFY, CellStyle.ALIGN_CENTER_SELECTION

setAlignment

public void setAlignment(HorizontalAlignment align)

Set the type of horizontal alignment for the cell

Parameters:

align - - the type of alignment

See Also:

HorizontalAlignment

setBorderBottom

public void setBorderBottom(short border)

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

Specified by:

setBorderBottom in interface CellStyle

Parameters:

border - the type of border to use

See Also:

CellStyle.BORDER_NONE, CellStyle.BORDER_THIN, CellStyle.BORDER_MEDIUM, CellStyle.BORDER_DASHED, CellStyle.BORDER_DOTTED, CellStyle.BORDER_THICK, CellStyle.BORDER_DOUBLE, CellStyle.BORDER_HAIR, CellStyle.BORDER_MEDIUM_DASHED, CellStyle.BORDER_DASH_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT, CellStyle.BORDER_DASH_DOT_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT_DOT, CellStyle.BORDER_SLANTED_DASH_DOT

setBorderBottom

public void setBorderBottom(BorderStyle border)

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

Parameters:

border - - type of border to use

See Also:

BorderStyle

setBorderLeft

public void setBorderLeft(short border)

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

Specified by:

setBorderLeft in interface CellStyle

Parameters:

border - the type of border to use

See Also:

CellStyle.BORDER_NONE, CellStyle.BORDER_THIN, CellStyle.BORDER_MEDIUM, CellStyle.BORDER_DASHED, CellStyle.BORDER_DOTTED, CellStyle.BORDER_THICK, CellStyle.BORDER_DOUBLE, CellStyle.BORDER_HAIR, CellStyle.BORDER_MEDIUM_DASHED, CellStyle.BORDER_DASH_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT, CellStyle.BORDER_DASH_DOT_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT_DOT, CellStyle.BORDER_SLANTED_DASH_DOT

setBorderLeft

public void setBorderLeft(BorderStyle border)

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

Parameters:

border - the type of border to use

setBorderRight

public void setBorderRight(short border)

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

Specified by:

setBorderRight in interface CellStyle

Parameters:

border - the type of border to use

See Also:

CellStyle.BORDER_NONE, CellStyle.BORDER_THIN, CellStyle.BORDER_MEDIUM, CellStyle.BORDER_DASHED, CellStyle.BORDER_DOTTED, CellStyle.BORDER_THICK, CellStyle.BORDER_DOUBLE, CellStyle.BORDER_HAIR, CellStyle.BORDER_MEDIUM_DASHED, CellStyle.BORDER_DASH_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT, CellStyle.BORDER_DASH_DOT_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT_DOT, CellStyle.BORDER_SLANTED_DASH_DOT

setBorderRight

public void setBorderRight(BorderStyle border)

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

Parameters:

border - the type of border to use

setBorderTop

public void setBorderTop(short border)

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

Specified by:

setBorderTop in interface CellStyle

Parameters:

border - the type of border to use

See Also:

CellStyle.BORDER_NONE, CellStyle.BORDER_THIN, CellStyle.BORDER_MEDIUM, CellStyle.BORDER_DASHED, CellStyle.BORDER_DOTTED, CellStyle.BORDER_THICK, CellStyle.BORDER_DOUBLE, CellStyle.BORDER_HAIR, CellStyle.BORDER_MEDIUM_DASHED, CellStyle.BORDER_DASH_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT, CellStyle.BORDER_DASH_DOT_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT_DOT, CellStyle.BORDER_SLANTED_DASH_DOT

setBorderTop

public void setBorderTop(BorderStyle border)

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

Parameters:

border - the type of border to use

setBottomBorderColor

public void setBottomBorderColor(short color)

Set the color to use for the bottom border

Specified by:

setBottomBorderColor in interface CellStyle

Parameters:

color - the index of the color definition

See Also:

IndexedColors

setBottomBorderColor

public void setBottomBorderColor(XSSFColor color)

Set the color to use for the bottom border

Parameters:

color - the color to use, null means no color

setDataFormat

public void setDataFormat(short fmt)

Set the index of a data format

Specified by:

setDataFormat in interface CellStyle

Parameters:

fmt - the index of a data format

See Also:

DataFormat

setFillBackgroundColor

public void setFillBackgroundColor(XSSFColor color)

Set the background fill color represented as a 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.

Parameters:

color - - the color to use

setFillBackgroundColor

public void setFillBackgroundColor(short bg)

Set the background fill color represented as a indexed color value.

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.

Specified by:

setFillBackgroundColor in interface CellStyle

Parameters:

bg - - the color to use

See Also:

IndexedColors

setFillForegroundColor

public void setFillForegroundColor(XSSFColor color)

Set the foreground fill color represented as a XSSFColor value.
Note: Ensure Foreground color is set prior to background color.

Parameters:

color - the color to use

See Also:

)

setFillForegroundColor

public void setFillForegroundColor(short fg)

Set the foreground fill color as a indexed color value
Note: Ensure Foreground color is set prior to background color.

Specified by:

setFillForegroundColor in interface CellStyle

Parameters:

fg - the color to use

See Also:

IndexedColors

setFillPattern

public void setFillPattern(short fp)

This element is used to specify cell fill information for pattern and solid color cell fills. For solid cell fills (no pattern), foregorund color is used. For cell fills with patterns specified, then the cell fill color is specified by the background color.

Specified by:

setFillPattern in interface CellStyle

Parameters:

fp - fill pattern (set to CellStyle.SOLID_FOREGROUND to fill w/foreground color)

See Also:

CellStyle.NO_FILL, CellStyle.SOLID_FOREGROUND, CellStyle.FINE_DOTS, CellStyle.ALT_BARS, CellStyle.SPARSE_DOTS, CellStyle.THICK_HORZ_BANDS, CellStyle.THICK_VERT_BANDS, CellStyle.THICK_BACKWARD_DIAG, CellStyle.THICK_FORWARD_DIAG, CellStyle.BIG_SPOTS, CellStyle.BRICKS, CellStyle.THIN_HORZ_BANDS, CellStyle.THIN_VERT_BANDS, CellStyle.THIN_BACKWARD_DIAG, CellStyle.THIN_FORWARD_DIAG, CellStyle.SQUARES, CellStyle.DIAMONDS, setFillBackgroundColor(short), setFillForegroundColor(short)

setFillPattern

public void setFillPattern(FillPatternType ptrn)

This element is used to specify cell fill information for pattern and solid color cell fills. For solid cell fills (no pattern), foreground color is used is used. For cell fills with patterns specified, then the cell fill color is specified by the background color element.

Parameters:

ptrn - the fill pattern to use

See Also:

setFillBackgroundColor(short), setFillForegroundColor(short), FillPatternType

setFont

public void setFont(Font font)

Set the font for this style

Specified by:

setFont in interface CellStyle

Parameters:

font - a font object created or retreived from the XSSFWorkbook object

See Also:

XSSFWorkbook.createFont(), XSSFWorkbook.getFontAt(short)

setHidden

public void setHidden(boolean hidden)

Set the cell's using this style to be hidden

Specified by:

setHidden in interface CellStyle

Parameters:

hidden - - whether the cell using this style should be hidden

setIndention

public void setIndention(short indent)

Set the number of spaces to indent the text in the cell

Specified by:

setIndention in interface CellStyle

Parameters:

indent - - number of spaces

setLeftBorderColor

public void setLeftBorderColor(short color)

Set the color to use for the left border as a indexed color value

Specified by:

setLeftBorderColor in interface CellStyle

Parameters:

color - the index of the color definition

See Also:

IndexedColors

setLeftBorderColor

public void setLeftBorderColor(XSSFColor color)

Set the color to use for the left border as a XSSFColor value

Parameters:

color - the color to use

setLocked

public void setLocked(boolean locked)

Set the cell's using this style to be locked

Specified by:

setLocked in interface CellStyle

Parameters:

locked - - whether the cell using this style should be locked

setRightBorderColor

public void setRightBorderColor(short color)

Set the color to use for the right border

Specified by:

setRightBorderColor in interface CellStyle

Parameters:

color - the index of the color definition

See Also:

IndexedColors

setRightBorderColor

public void setRightBorderColor(XSSFColor color)

Set the color to use for the right border as a XSSFColor value

Parameters:

color - the color to use

setRotation

public void setRotation(short rotation)

Set the degree of rotation for the text in the cell

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.

Specified by:

setRotation in interface CellStyle

Parameters:

rotation - - the rotation degrees (between 0 and 180 degrees)

setTopBorderColor

public void setTopBorderColor(short color)

Set the color to use for the top border

Specified by:

setTopBorderColor in interface CellStyle

Parameters:

color - the index of the color definition

See Also:

IndexedColors

setTopBorderColor

public void setTopBorderColor(XSSFColor color)

Set the color to use for the top border as a XSSFColor value

Parameters:

color - the color to use

setVerticalAlignment

public void setVerticalAlignment(short align)

Set the type of vertical alignment for the cell

Specified by:

setVerticalAlignment in interface CellStyle

Parameters:

align - - align the type of alignment

See Also:

CellStyle.VERTICAL_TOP, CellStyle.VERTICAL_CENTER, CellStyle.VERTICAL_BOTTOM, CellStyle.VERTICAL_JUSTIFY, VerticalAlignment

setVerticalAlignment

public void setVerticalAlignment(VerticalAlignment align)

Set the type of vertical alignment for the cell

Parameters:

align - - the type of alignment

setWrapText

public void setWrapText(boolean wrapped)

Set whether the text should be wrapped.

Setting this flag to true make all content visible whithin a cell by displaying it on multiple lines

Specified by:

setWrapText in interface CellStyle

Parameters:

wrapped - a boolean value indicating if the text in a cell should be line-wrapped within the cell.

getBorderColor

public XSSFColor getBorderColor(XSSFCellBorder.BorderSide side)

Gets border color

Parameters:

side - the border side

Returns:

the used color

setBorderColor

public void setBorderColor(XSSFCellBorder.BorderSide side,
                  XSSFColor color)

Set the color to use for the selected border

Parameters:

side - - where to apply the color definition

color - - the color to use

getCellAlignment

protected XSSFCellAlignment getCellAlignment()

get the cellAlignment object to use for manage alignment

Returns:

XSSFCellAlignment - cell alignment

hashCode

public int hashCode()

Returns a hash code value for the object. The hash is derived from the underlying CTXf bean.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code value for this style

equals

public boolean equals(java.lang.Object o)

Checks is the supplied style is equal to this style

Overrides:

equals in class java.lang.Object

Parameters:

o - the style to check

Returns:

true if the supplied style is equal to this style

clone

public java.lang.Object clone()

Make a copy of this style. The underlying CTXf bean is cloned, the references to fills and borders remain.

Overrides:

clone in class java.lang.Object

Returns:

a copy of this style

getLeftBorderColorColor

public XSSFColor getLeftBorderColorColor()

Specified by:

getLeftBorderColorColor in interface CellStyle

getRightBorderColorColor

public XSSFColor getRightBorderColorColor()

Specified by:

getRightBorderColorColor in interface CellStyle

getTopBorderColorColor

public XSSFColor getTopBorderColorColor()

Specified by:

getTopBorderColorColor in interface CellStyle

getBottomBorderColorColor

public XSSFColor getBottomBorderColorColor()

Specified by:

getBottomBorderColorColor in interface CellStyle

setFontColorColor

public void setFontColorColor(Color color)

Specified by:

setFontColorColor in interface CellStyle

getCellXf

@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTXf getCellXf()

setBorder

@Internal
public void setBorder(short left,
                      Color leftColor,
                      short top,
                      Color topColor,
                      short right,
                      Color rightColor,
                      short bottom,
                      Color bottomColor)

Specified by:

setBorder in interface CellStyle

setFill

public void setFill(Color fillColor,
           Color backColor,
           short patternType)

Specified by:

setFill in interface CellStyle

setCellAlignment

public void setCellAlignment(short hAlign,
                    short vAlign,
                    boolean wrapText)

Specified by:

setCellAlignment in interface CellStyle

setProtection

public void setProtection(boolean locked,
                 boolean hidden)

Specified by:

setProtection in interface CellStyle

setBorderDiagonal

public void setBorderDiagonal(short border)

Description copied from interface: CellStyle

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

Specified by:

setBorderDiagonal in interface CellStyle

Parameters:

border - type

See Also:

CellStyle.BORDER_NONE, CellStyle.BORDER_THIN, CellStyle.BORDER_MEDIUM, CellStyle.BORDER_DASHED, CellStyle.BORDER_DOTTED, CellStyle.BORDER_THICK, CellStyle.BORDER_DOUBLE, CellStyle.BORDER_HAIR, CellStyle.BORDER_MEDIUM_DASHED, CellStyle.BORDER_DASH_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT, CellStyle.BORDER_DASH_DOT_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT_DOT, CellStyle.BORDER_SLANTED_DASH_DOT

getBorderDiagonal

public short getBorderDiagonal()

Description copied from interface: CellStyle

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

Specified by:

getBorderDiagonal in interface CellStyle

Returns:

border type

See Also:

CellStyle.BORDER_NONE, CellStyle.BORDER_THIN, CellStyle.BORDER_MEDIUM, CellStyle.BORDER_DASHED, CellStyle.BORDER_DOTTED, CellStyle.BORDER_THICK, CellStyle.BORDER_DOUBLE, CellStyle.BORDER_HAIR, CellStyle.BORDER_MEDIUM_DASHED, CellStyle.BORDER_DASH_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT, CellStyle.BORDER_DASH_DOT_DOT, CellStyle.BORDER_MEDIUM_DASH_DOT_DOT, CellStyle.BORDER_SLANTED_DASH_DOT

getDiagonalBorderColorColor

public Color getDiagonalBorderColorColor()

Specified by:

getDiagonalBorderColorColor in interface CellStyle

Returns:

setDiagonalBorderColor

public void setDiagonalBorderColor(short color)

Description copied from interface: CellStyle

set the color to use for the diagonal border

Specified by:

setDiagonalBorderColor in interface CellStyle

Parameters:

color - The index of the color definition

getDiagonalBorderColor

public short getDiagonalBorderColor()

Description copied from interface: CellStyle

get the color to use for the diagonal border

Specified by:

getDiagonalBorderColor in interface CellStyle

getDiagonalBorderXSSFColor

public XSSFColor getDiagonalBorderXSSFColor()

Get the color to use for the left border

Returns:

the index of the color definition or null if not set

See Also:

IndexedColors

getVerticalBorderXSSFColor

public XSSFColor getVerticalBorderXSSFColor()

Get the color to use for the left border

Returns:

the index of the color definition or null if not set

See Also:

IndexedColors

getHorizontalBorderXSSFColor

public XSSFColor getHorizontalBorderXSSFColor()

Get the color to use for the horizontal border

Returns:

the index of the color definition or null if not set

See Also:

IndexedColors

setDiagonalBorderColor

public void setDiagonalBorderColor(XSSFColor color)

Set the color to use for the left border as a XSSFColor value

Parameters:

color - the color to use

setHorizontalBorderColor

public void setHorizontalBorderColor(XSSFColor color)

Set the color to use for the left border as a XSSFColor value

Parameters:

color - the color to use

setVerticalBorderColor

public void setVerticalBorderColor(XSSFColor color)

Set the color to use for the left border as a XSSFColor value

Parameters:

color - the color to use

isShowDiagonalUpBorder

public boolean isShowDiagonalUpBorder()

Description copied from interface: CellStyle

Whether show diagonalUp diagonal border

Specified by:

isShowDiagonalUpBorder in interface CellStyle

Returns:

isShowDiagonalDownBorder

public boolean isShowDiagonalDownBorder()

Description copied from interface: CellStyle

Whether show diagonalDown diagonal border

Specified by:

isShowDiagonalDownBorder in interface CellStyle

Returns:

setShowDiagonalUpBorder

public void setShowDiagonalUpBorder(boolean up)

Description copied from interface: CellStyle

Whether show diagonalUp diagonal border

Specified by:

setShowDiagonalUpBorder in interface CellStyle

setShowDiagonalDownBorder

public void setShowDiagonalDownBorder(boolean down)

Description copied from interface: CellStyle

Whether show diagonalDown diagonal border

Specified by:

setShowDiagonalDownBorder in interface CellStyle

setBorder

@Internal
public void setBorder(short left,
                      Color leftColor,
                      short top,
                      Color topColor,
                      short right,
                      Color rightColor,
                      short bottom,
                      Color bottomColor,
                      short diagonal,
                      Color diagonalColor,
                      short horizontal,
                      Color horizontalColor,
                      short vertical,
                      Color verticalColor,
                      boolean diaUp,
                      boolean diaDown)

Specified by:

setBorder in interface CellStyle

setDefaultCellAlignment

public void setDefaultCellAlignment(short hAlign,
                           short vAlign,
                           boolean wrapText)

setDefaultProtection

public void setDefaultProtection(boolean locked,
                        boolean hidden)