org.zkoss.poi.xssf.usermodel

Class XSSFNamedStyle

java.lang.Object

org.zkoss.poi.xssf.usermodel.XSSFNamedStyle

All Implemented Interfaces:

CellStyle, NamedStyle

public class XSSFNamedStyle
extends java.lang.Object
implements NamedStyle

Since:

3.9.6

Author:

henri

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
XSSFNamedStyle(java.lang.String name, boolean custom, int builtinId, int xfId, StylesTable stylesSource, ThemesTable theme)

Method Summary

Modifier and Type	Method and Description
void	cloneStyleFrom(CellStyle source) Clones all the style information from another CellStyle, onto this one.
short	getAlignment() 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
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
short	getBorderRight() 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
short	getBottomBorderColor() get the color to use for the left border
Color	getBottomBorderColorColor()
int	getBuiltinId()
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCellStyle	getCellStyle()
short	getDataFormat() get the index of the format
java.lang.String	getDataFormatString() Get the format string
short	getDiagonalBorderColor() get the color to use for the diagonal border
Color	getDiagonalBorderColorColor()
short	getFillBackgroundColor() get the background fill color, if the fill is defined with an indexed color.
Color	getFillBackgroundColorColor() Gets the color object representing the current background fill, resolving indexes using the supplied workbook.
short	getFillForegroundColor() get the foreground fill color, if the fill is defined with an indexed color.
Color	getFillForegroundColorColor() Gets the color object representing the current foreground fill, resolving indexes using the supplied workbook.
short	getFillPattern() get the fill pattern (??)
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
short	getIndention() get the number of spaces to indent the text in the cell
int	getIndex() get the index within the Workbook (sequence within the collection of ExtnededFormat objects) Note since 3.9.9 we have changed the return value type from short to int because the limit of distinct cell styles in Excel 2007 and beyond is 64000 while that of Excel 97-2003 is 4000 only; have to extend it to accommodate the capacity.
short	getLeftBorderColor() get the color to use for the left border
Color	getLeftBorderColorColor()
boolean	getLocked() get whether the cell's using this style are to be locked
java.lang.String	getName()
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 left border
Color	getRightBorderColorColor()
short	getRotation() get the degree of rotation for the text in the cell
short	getTopBorderColor() get the color to use for the top border
Color	getTopBorderColorColor()
short	getVerticalAlignment() get the type of vertical alignment for the cell
boolean	getWrapText() get whether the text should be wrapped
boolean	isBuiltinDataFormat() Check if the data format is build in format
boolean	isCustomBuiltin()
boolean	isShowDiagonalDownBorder() Whether show diagonalDown diagonal border
boolean	isShowDiagonalUpBorder() Whether show diagonalUp diagonal border
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(short border) set the type of border to use for the bottom border of the cell
void	setBorderDiagonal(short border) set the type of border to use for the diagonal border of the cell
void	setBorderLeft(short border) set the type of border to use for the left border of the cell
void	setBorderRight(short border) set the type of border to use for the right 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	setCellAlignment(short hAlign, short vAlign, boolean wrapText) Deprecated.
void	setCellAlignment(short hAlign, short vAlign, boolean wrapText, short rotation)
void	setDataFormat(short fmt) set the data format (must be a valid format)
void	setDiagonalBorderColor(short color) set the color to use for the diagonal border
void	setFill(Color fillColor, Color backColor, short pattern)
void	setFillBackgroundColor(short bg) set the background fill color.
void	setFillForegroundColor(short bg) set the foreground fill color Note: Ensure Foreground color is set prior to background color.
void	setFillPattern(short fp) setting to one fills the cell with the foreground color...
void	setFont(Font font) set the font for this style
void	setFontColorColor(Color fontColor)
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
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	setRotation(short rotation) set the degree of rotation for the text in the cell
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	setVerticalAlignment(short align) set the type of vertical alignment for the cell
void	setWrapText(boolean wrapped) Set whether the text should be wrapped.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XSSFNamedStyle

public XSSFNamedStyle(java.lang.String name,
                      boolean custom,
                      int builtinId,
                      int xfId,
                      StylesTable stylesSource,
                      ThemesTable theme)

Method Detail

getCellStyle

public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCellStyle getCellStyle()

getName

public java.lang.String getName()

Specified by:

getName in interface NamedStyle

isCustomBuiltin

public boolean isCustomBuiltin()

Specified by:

isCustomBuiltin in interface NamedStyle

getBuiltinId

public int getBuiltinId()

Specified by:

getBuiltinId in interface NamedStyle

getIndex

public int getIndex()

Description copied from interface: CellStyle

get the index within the Workbook (sequence within the collection of ExtnededFormat objects) Note since 3.9.9 we have changed the return value type from short to int because the limit of distinct cell styles in Excel 2007 and beyond is 64000 while that of Excel 97-2003 is 4000 only; have to extend it to accommodate the capacity.

Specified by:

getIndex in interface CellStyle

Returns:

unique index number of the underlying record this style represents (probably you don't care unless you're comparing which one is which)

setDataFormat

public void setDataFormat(short fmt)

Description copied from interface: CellStyle

set the data format (must be a valid format)

Specified by:

setDataFormat in interface CellStyle

See Also:

DataFormat

getDataFormat

public short getDataFormat()

Description copied from interface: CellStyle

get the index of the format

Specified by:

getDataFormat in interface CellStyle

See Also:

DataFormat

getDataFormatString

public java.lang.String getDataFormatString()

Description copied from interface: CellStyle

Get the format string

Specified by:

getDataFormatString in interface CellStyle

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:

setFont

public void setFont(Font font)

Description copied from interface: CellStyle

set the font for this style

Specified by:

setFont in interface CellStyle

Parameters:

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

See Also:

Workbook.createFont(), Workbook.getFontAt(short)

getFontIndex

public short getFontIndex()

Description copied from interface: CellStyle

gets the index of the font for this style

Specified by:

getFontIndex in interface CellStyle

See Also:

Workbook.getFontAt(short)

setHidden

public void setHidden(boolean hidden)

Description copied from interface: CellStyle

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

getHidden

public boolean getHidden()

Description copied from interface: CellStyle

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

Specified by:

getHidden in interface CellStyle

Returns:

hidden - whether the cell using this style should be hidden

setLocked

public void setLocked(boolean locked)

Description copied from interface: CellStyle

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

getLocked

public boolean getLocked()

Description copied from interface: CellStyle

get whether the cell's using this style are to be locked

Specified by:

getLocked in interface CellStyle

Returns:

hidden - whether the cell using this style should be locked

setAlignment

public void setAlignment(short align)

Description copied from interface: CellStyle

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

getAlignment

public short getAlignment()

Description copied from interface: CellStyle

get the type of horizontal alignment for the cell

Specified by:

getAlignment in interface CellStyle

Returns:

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

setWrapText

public void setWrapText(boolean wrapped)

Description copied from interface: CellStyle

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 - wrap text or not

getWrapText

public boolean getWrapText()

Description copied from interface: CellStyle

get whether the text should be wrapped

Specified by:

getWrapText in interface CellStyle

Returns:

wrap text or not

setVerticalAlignment

public void setVerticalAlignment(short align)

Description copied from interface: CellStyle

set the type of vertical alignment for the cell

Specified by:

setVerticalAlignment in interface CellStyle

Parameters:

align - the type of alignment

See Also:

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

getVerticalAlignment

public short getVerticalAlignment()

Description copied from interface: CellStyle

get the type of vertical alignment for the cell

Specified by:

getVerticalAlignment in interface CellStyle

Returns:

align the type of alignment

See Also:

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

setRotation

public void setRotation(short rotation)

Description copied from interface: CellStyle

set the degree of rotation for the text in the cell

Specified by:

setRotation in interface CellStyle

Parameters:

rotation - degrees (between -90 and 90 degrees)

getRotation

public short getRotation()

Description copied from interface: CellStyle

get the degree of rotation for the text in the cell

Specified by:

getRotation in interface CellStyle

Returns:

rotation degrees (between -90 and 90 degrees)

setIndention

public void setIndention(short indent)

Description copied from interface: CellStyle

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

Specified by:

setIndention in interface CellStyle

Parameters:

indent - - number of spaces

getIndention

public short getIndention()

Description copied from interface: CellStyle

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

Specified by:

getIndention in interface CellStyle

Returns:

indent - number of spaces

setBorderLeft

public void setBorderLeft(short border)

Description copied from interface: CellStyle

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

Specified by:

setBorderLeft 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

getBorderLeft

public short getBorderLeft()

Description copied from interface: CellStyle

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

Specified by:

getBorderLeft 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

setBorderRight

public void setBorderRight(short border)

Description copied from interface: CellStyle

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

Specified by:

setBorderRight 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

getBorderRight

public short getBorderRight()

Description copied from interface: CellStyle

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

Specified by:

getBorderRight 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

setBorderTop

public void setBorderTop(short border)

Description copied from interface: CellStyle

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

Specified by:

setBorderTop 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

getBorderTop

public short getBorderTop()

Description copied from interface: CellStyle

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

Specified by:

getBorderTop 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

setBorderBottom

public void setBorderBottom(short border)

Description copied from interface: CellStyle

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

Specified by:

setBorderBottom 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

getBorderBottom

public short getBorderBottom()

Description copied from interface: CellStyle

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

Specified by:

getBorderBottom 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

setLeftBorderColor

public void setLeftBorderColor(short color)

Description copied from interface: CellStyle

set the color to use for the left border

Specified by:

setLeftBorderColor in interface CellStyle

Parameters:

color - The index of the color definition

getLeftBorderColor

public short getLeftBorderColor()

Description copied from interface: CellStyle

get the color to use for the left border

Specified by:

getLeftBorderColor in interface CellStyle

setRightBorderColor

public void setRightBorderColor(short color)

Description copied from interface: CellStyle

set the color to use for the right border

Specified by:

setRightBorderColor in interface CellStyle

Parameters:

color - The index of the color definition

getRightBorderColor

public short getRightBorderColor()

Description copied from interface: CellStyle

get the color to use for the left border

Specified by:

getRightBorderColor in interface CellStyle

Returns:

the index of the color definition

setTopBorderColor

public void setTopBorderColor(short color)

Description copied from interface: CellStyle

set the color to use for the top border

Specified by:

setTopBorderColor in interface CellStyle

Parameters:

color - The index of the color definition

getTopBorderColor

public short getTopBorderColor()

Description copied from interface: CellStyle

get the color to use for the top border

Specified by:

getTopBorderColor in interface CellStyle

Returns:

hhe index of the color definition

setBottomBorderColor

public void setBottomBorderColor(short color)

Description copied from interface: CellStyle

set the color to use for the bottom border

Specified by:

setBottomBorderColor in interface CellStyle

Parameters:

color - The index of the color definition

getBottomBorderColor

public short getBottomBorderColor()

Description copied from interface: CellStyle

get the color to use for the left border

Specified by:

getBottomBorderColor in interface CellStyle

Returns:

the index of the color definition

setFillPattern

public void setFillPattern(short fp)

Description copied from interface: CellStyle

setting to one fills the cell with the foreground color... No idea about other values

Specified by:

setFillPattern in interface CellStyle

Parameters:

fp - fill pattern (set to 1 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

getFillPattern

public short getFillPattern()

Description copied from interface: CellStyle

get the fill pattern (??) - set to 1 to fill with foreground color

Specified by:

getFillPattern in interface CellStyle

Returns:

fill pattern

setFillBackgroundColor

public void setFillBackgroundColor(short bg)

Description copied from interface: CellStyle

set the background fill color.

Specified by:

setFillBackgroundColor in interface CellStyle

Parameters:

bg - color

getFillBackgroundColor

public short getFillBackgroundColor()

Description copied from interface: CellStyle

get the background fill color, if the fill is defined with an indexed color.

Specified by:

getFillBackgroundColor in interface CellStyle

Returns:

fill color index, or 0 if not indexed (XSSF only)

getFillBackgroundColorColor

public Color 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

setFillForegroundColor

public void setFillForegroundColor(short bg)

Description copied from interface: CellStyle

set the foreground fill color Note: Ensure Foreground color is set prior to background color.

Specified by:

setFillForegroundColor in interface CellStyle

Parameters:

bg - color

getFillForegroundColor

public short getFillForegroundColor()

Description copied from interface: CellStyle

get the foreground fill color, if the fill is defined with an indexed color.

Specified by:

getFillForegroundColor in interface CellStyle

Returns:

fill color, or 0 if not indexed (XSSF only)

getFillForegroundColorColor

public Color 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

cloneStyleFrom

public void cloneStyleFrom(CellStyle source)

Description copied from interface: CellStyle

Clones all the style information from another CellStyle, onto this one. This CellStyle will then have all the same properties as the source, but the two may be edited independently. Any stylings on this CellStyle will be lost! The source CellStyle could be from another Workbook if you like. This allows you to copy styles from one Workbook to another. However, both of the CellStyles will need to be of the same type (HSSFCellStyle or XSSFCellStyle)

Specified by:

cloneStyleFrom in interface CellStyle

getTopBorderColorColor

public Color getTopBorderColorColor()

Specified by:

getTopBorderColorColor in interface CellStyle

getBottomBorderColorColor

public Color getBottomBorderColorColor()

Specified by:

getBottomBorderColorColor in interface CellStyle

getRightBorderColorColor

public Color getRightBorderColorColor()

Specified by:

getRightBorderColorColor in interface CellStyle

getLeftBorderColorColor

public Color getLeftBorderColorColor()

Specified by:

getLeftBorderColorColor in interface CellStyle

setFontColorColor

public void setFontColorColor(Color fontColor)

Specified by:

setFontColorColor in interface CellStyle

setBorder

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 pattern)

Specified by:

setFill in interface CellStyle

setCellAlignment

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

Deprecated.

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

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

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

setCellAlignment

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

Specified by:

setCellAlignment in interface CellStyle