|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.hssf.usermodel.HSSFCellStyle
public final class HSSFCellStyle
High level representation of the style of a cell in a sheet of a workbook.
HSSFWorkbook.createCellStyle()
,
HSSFWorkbook.getCellStyleAt(short)
,
HSSFCell.setCellStyle(HSSFCellStyle)
Field Summary |
---|
Constructor Summary | |
---|---|
protected |
HSSFCellStyle(short index,
ExtendedFormatRecord rec,
HSSFWorkbook workbook)
Creates new HSSFCellStyle why would you want to do this?? |
protected |
HSSFCellStyle(short index,
ExtendedFormatRecord rec,
InternalWorkbook workbook)
|
Method Summary | |
---|---|
void |
cloneStyleFrom(CellStyle source)
Clones all the style information from another HSSFCellStyle, onto this one. |
void |
cloneStyleFrom(HSSFCellStyle source)
|
boolean |
equals(java.lang.Object obj)
|
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 |
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 |
short |
getDataFormat()
get the index of the format |
java.lang.String |
getDataFormatString()
Get the contents of the format string, by looking up the DataFormat against the bound workbook |
java.lang.String |
getDataFormatString(InternalWorkbook workbook)
Get the contents of the format string, by looking up the DataFormat against the supplied low level workbook |
java.lang.String |
getDataFormatString(Workbook workbook)
Get the contents of the format string, by looking up the DataFormat against the supplied workbook |
short |
getFillBackgroundColor()
Get the background fill color. |
HSSFColor |
getFillBackgroundColorColor()
Gets the color object representing the current background fill, resolving indexes using the supplied workbook. |
short |
getFillForegroundColor()
Get the foreground fill color. |
HSSFColor |
getFillForegroundColorColor()
Gets the color object representing the current foreground fill, resolving indexes using the supplied workbook. |
short |
getFillPattern()
get the fill pattern (??) - set to 1 to fill with foreground color |
HSSFFont |
getFont(Workbook parentWorkbook)
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 |
short |
getIndention()
get the number of spaces to indent the text in the cell |
short |
getIndex()
get the index within the HSSFWorkbook (sequence within the collection of ExtnededFormat objects) |
short |
getLeftBorderColor()
get the color to use for the left border |
boolean |
getLocked()
get whether the cell's using this style are to be locked |
HSSFCellStyle |
getParentStyle()
Return the parent style for this cell style. |
short |
getRightBorderColor()
get the color to use for the left border |
short |
getRotation()
get the degree of rotation for the text in the cell |
short |
getTopBorderColor()
get the color to use for the top border |
java.lang.String |
getUserStyleName()
Gets the name of the user defined style. |
short |
getVerticalAlignment()
get the type of vertical alignment for the cell |
boolean |
getWrapText()
get whether the text should be wrapped |
int |
hashCode()
|
void |
setAlignment(short align)
set the type of horizontal alignment for the cell |
void |
setBorderBottom(short border)
set the type of border to use for the bottom 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 |
setDataFormat(short fmt)
set the data format (must be a valid format) |
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 |
setFont(HSSFFont font)
|
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 |
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 |
setTopBorderColor(short color)
set the color to use for the top border |
void |
setUserStyleName(java.lang.String styleName)
Sets the name of the user defined style. |
void |
setVerticalAlignment(short align)
set the type of vertical alignment for the cell |
void |
setWrapText(boolean wrapped)
set whether the text should be wrapped |
void |
verifyBelongsToWorkbook(HSSFWorkbook wb)
Verifies that this style belongs to the supplied Workbook. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected HSSFCellStyle(short index, ExtendedFormatRecord rec, HSSFWorkbook workbook)
protected HSSFCellStyle(short index, ExtendedFormatRecord rec, InternalWorkbook workbook)
Method Detail |
---|
public short getIndex()
getIndex
in interface CellStyle
public HSSFCellStyle getParentStyle()
public void setDataFormat(short fmt)
setDataFormat
in interface CellStyle
HSSFDataFormat
public short getDataFormat()
getDataFormat
in interface CellStyle
HSSFDataFormat
public java.lang.String getDataFormatString()
getDataFormatString
in interface CellStyle
HSSFDataFormat
public java.lang.String getDataFormatString(Workbook workbook)
HSSFDataFormat
public java.lang.String getDataFormatString(InternalWorkbook workbook)
HSSFDataFormat
public void setFont(Font font)
setFont
in interface CellStyle
font
- a font object created or retreived from the HSSFWorkbook objectHSSFWorkbook.createFont()
,
HSSFWorkbook.getFontAt(short)
public void setFont(HSSFFont font)
public short getFontIndex()
getFontIndex
in interface CellStyle
HSSFWorkbook.getFontAt(short)
public HSSFFont getFont(Workbook parentWorkbook)
parentWorkbook
- The HSSFWorkbook that this style belongs togetFontIndex()
,
HSSFWorkbook.getFontAt(short)
public void setHidden(boolean hidden)
setHidden
in interface CellStyle
hidden
- - whether the cell using this style should be hiddenpublic boolean getHidden()
getHidden
in interface CellStyle
public void setLocked(boolean locked)
setLocked
in interface CellStyle
locked
- - whether the cell using this style should be lockedpublic boolean getLocked()
getLocked
in interface CellStyle
public void setAlignment(short align)
setAlignment
in interface CellStyle
align
- - the type of alignmentCellStyle.ALIGN_GENERAL
,
CellStyle.ALIGN_LEFT
,
CellStyle.ALIGN_CENTER
,
CellStyle.ALIGN_RIGHT
,
CellStyle.ALIGN_FILL
,
CellStyle.ALIGN_JUSTIFY
,
CellStyle.ALIGN_CENTER_SELECTION
public short getAlignment()
getAlignment
in interface CellStyle
CellStyle.ALIGN_GENERAL
,
CellStyle.ALIGN_LEFT
,
CellStyle.ALIGN_CENTER
,
CellStyle.ALIGN_RIGHT
,
CellStyle.ALIGN_FILL
,
CellStyle.ALIGN_JUSTIFY
,
CellStyle.ALIGN_CENTER_SELECTION
public void setWrapText(boolean wrapped)
setWrapText
in interface CellStyle
wrapped
- wrap text or notpublic boolean getWrapText()
getWrapText
in interface CellStyle
public void setVerticalAlignment(short align)
setVerticalAlignment
in interface CellStyle
align
- the type of alignmentCellStyle.VERTICAL_TOP
,
CellStyle.VERTICAL_CENTER
,
CellStyle.VERTICAL_BOTTOM
,
CellStyle.VERTICAL_JUSTIFY
public short getVerticalAlignment()
getVerticalAlignment
in interface CellStyle
CellStyle.VERTICAL_TOP
,
CellStyle.VERTICAL_CENTER
,
CellStyle.VERTICAL_BOTTOM
,
CellStyle.VERTICAL_JUSTIFY
public void setRotation(short rotation)
setRotation
in interface CellStyle
rotation
- degrees (between -90 and 90 degrees, of 0xff for vertical)public short getRotation()
getRotation
in interface CellStyle
public void setIndention(short indent)
setIndention
in interface CellStyle
indent
- - number of spacespublic short getIndention()
getIndention
in interface CellStyle
public void setBorderLeft(short border)
setBorderLeft
in interface CellStyle
border
- typeCellStyle.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
public short getBorderLeft()
getBorderLeft
in interface CellStyle
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
public void setBorderRight(short border)
setBorderRight
in interface CellStyle
border
- typeCellStyle.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
public short getBorderRight()
getBorderRight
in interface CellStyle
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
public void setBorderTop(short border)
setBorderTop
in interface CellStyle
border
- typeCellStyle.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
public short getBorderTop()
getBorderTop
in interface CellStyle
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
public void setBorderBottom(short border)
setBorderBottom
in interface CellStyle
border
- typeCellStyle.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
public short getBorderBottom()
getBorderBottom
in interface CellStyle
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
public void setLeftBorderColor(short color)
setLeftBorderColor
in interface CellStyle
color
- The index of the color definitionpublic short getLeftBorderColor()
getLeftBorderColor
in interface CellStyle
HSSFPalette.getColor(short)
public void setRightBorderColor(short color)
setRightBorderColor
in interface CellStyle
color
- The index of the color definitionpublic short getRightBorderColor()
getRightBorderColor
in interface CellStyle
HSSFPalette.getColor(short)
public void setTopBorderColor(short color)
setTopBorderColor
in interface CellStyle
color
- The index of the color definitionpublic short getTopBorderColor()
getTopBorderColor
in interface CellStyle
HSSFPalette.getColor(short)
public void setBottomBorderColor(short color)
setBottomBorderColor
in interface CellStyle
color
- The index of the color definitionpublic short getBottomBorderColor()
getBottomBorderColor
in interface CellStyle
HSSFPalette.getColor(short)
public void setFillPattern(short fp)
setFillPattern
in interface CellStyle
fp
- fill pattern (set to 1 to fill w/foreground color)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
public short getFillPattern()
getFillPattern
in interface CellStyle
public void setFillBackgroundColor(short bg)
For example:
cs.setFillPattern(HSSFCellStyle.FINE_DOTS ); cs.setFillBackgroundColor(new HSSFColor.RED().getIndex());optionally a Foreground and background fill can be applied: Note: Ensure Foreground color is set prior to background
cs.setFillPattern(HSSFCellStyle.FINE_DOTS ); cs.setFillForegroundColor(new HSSFColor.BLUE().getIndex()); cs.setFillBackgroundColor(new HSSFColor.RED().getIndex());or, for the special case of SOLID_FILL:
cs.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND ); cs.setFillForegroundColor(new HSSFColor.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
- colorpublic short getFillBackgroundColor()
getFillForegroundColor()
getFillBackgroundColor
in interface CellStyle
HSSFPalette.getColor(short)
public HSSFColor getFillBackgroundColorColor()
CellStyle
getFillBackgroundColorColor
in interface CellStyle
public void setFillForegroundColor(short bg)
setFillForegroundColor
in interface CellStyle
bg
- colorpublic short getFillForegroundColor()
getFillBackgroundColor()
)
getFillForegroundColor
in interface CellStyle
HSSFPalette.getColor(short)
public HSSFColor getFillForegroundColorColor()
CellStyle
getFillForegroundColorColor
in interface CellStyle
public java.lang.String getUserStyleName()
public void setUserStyleName(java.lang.String styleName)
public void verifyBelongsToWorkbook(HSSFWorkbook wb)
java.lang.IllegalArgumentException
- if there's a workbook mis-matchpublic void cloneStyleFrom(CellStyle source)
cloneStyleFrom
in interface CellStyle
public void cloneStyleFrom(HSSFCellStyle source)
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |