CellHandle (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.OpenXLS.CellHandle

All Implemented Interfaces:

Cell, Handle, Serializable, Comparable<CellHandle>
```
public class CellHandle
extends Object
implements Cell, Serializable, Handle, Comparable<CellHandle>
```
The CellHandle provides a handle to an XLS Cell and its values.
Use the CellHandle to work with individual Cells in an XLS file.
To instantiate a CellHandle, you must first have a valid WorkSheetHandle, which in turn requires a valid WorkBookHandle.

for example:

WorkBookHandle book = newWorkBookHandle("testxls.xls");
WorkSheetHandle sheet1 = book.getWorkSheet("Sheet1");
CellHandlecell = sheet1.getCell("B22");

With a CellHandle you can:

- get the value of a Cell
- set the value of a Cell
- change the color, font, and background formatting of a Cell
- change the formatting pattern of a Cell
- change the value of a Cell
- get a handle to any Formula for this Cell

Starter Inc.

See Also:

WorkBookHandle, WorkSheetHandle, FormulaHandle, CellNotFoundException, CellTypeMismatchException, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`NOTATION_SCIENTIFIC`
`static int`	`NOTATION_SCIENTIFIC_EXCEL`
`static int`	`NOTATION_STANDARD`
`static int`	`TYPE_BLANK` Cell types
`static int`	`TYPE_BOOLEAN`
`static int`	`TYPE_DOUBLE`
`static int`	`TYPE_FORMULA`
`static int`	`TYPE_FP`
`static int`	`TYPE_INT`
`static int`	`TYPE_STRING`

Constructor Summary

Constructors
Constructor and Description
`CellHandle(BiffRec c)` Public Constructor added for use in Bean-context ONLY.
`CellHandle(BiffRec c, WorkBook myb)` Public Constructor added for use in Bean-context ONLY.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addConditionalFormat(ConditionalFormatHandle format)` Set a conditional format upon this cell.
`List<CellHandle>`	`calculateAffectedCells()` Calculates and returns all formulas that reference this CellHandle.
`List<CellHandle>`	`calculateAffectedCellsOnSheet()` Calculates and returns all formulas on the same sheet that reference this CellHandle.
`void`	`clear()` Resets this cell to the default, as if it had just been added.
`protected void`	`clearAffectedCells()` Internal method for clearing affected cells, does the same thing as calculateAffectedCells, but does not create a list
`void`	`clearChartReferences()` flags chart references to the particular cell as dirty/ needing caches rebuilt
`void`	`clearContents()` Resets this cells contents to blank.
`void`	`clearFormats()` Resets this cell's format to the default.
`int`	`compareTo(CellHandle that)`
`protected static CellHandle`	`copyCellHelper(CellHandle sourcecell, CellHandle newcell)` Copies all formatting - xf and non-xf (such as column width, hidden state) plus merged cell range from a sourcecell to a new cell (usually in a new workbook)
`static CellHandle`	`copyCellToWorkSheet(CellHandle sourcecell, WorkSheetHandle newsheet)` Create a copy of this Cell in another WorkBook
`static CellHandle`	`copyCellToWorkSheet(CellHandle sourcecell, WorkSheetHandle newsheet, int row, int col)` Creates a copy of this cell on the given worksheet at the given address.
`static CellHandle`	`copyCellToWorkSheet(CellHandle sourcecell, WorkSheetHandle newsheet, int row, int col, boolean copyByValue)` Creates a copy of this cell on the given worksheet at the given address.
`void`	`copyFormat(CellHandle source)` Copy all formats from a source Cell to this Cell
`CellHandle`	`copyTo(String newaddr)` copy this Cell to another location.
`CommentHandle`	`createComment(String comment, String author)` Creates a new annotation (Note or Comment) to the cell
`boolean`	`equals(Object that)`
`void`	`fireParserEvent()` this method will be fired as each record is parsed from an input Spreadsheet Dec 15, 2010
`Font`	`getAwtFont()` convert the OpenXLS font used by this Cell to java.awt.Font
`Color`	`getBackgroundColor()` get the Color of the Cell Background by this Cell and all other cells sharing this FormatId.
`int`	`getBackgroundPattern()` get the Background Pattern for this cell
`boolean`	`getBooleanVal()` returns the value of this Cell as a boolean If the Cell is not of type Boolean, returns false
`Color[]`	`getBorderColors()` returns Border Colors of Cell in: top, left, bottom, right order returns null or a java.awt.Color object for each of 4 sides
`byte[]`	`getBytes()` returns the low-level bytes for the underlying BIFF8 record.
`BiffRec`	`getCell()` return the underlying cell record for internal API use only
`String`	`getCellAddress()` Returns the Address of this Cell as a String.
`String`	`getCellAddressWithSheet()` Returns the Address of this Cell as a String.
`Color`	`getCellBackgroundColor()` Return the cell background color i.e.
`int`	`getCellRotation()` Get the rotation of this Cell in degrees.
`int`	`getCellType()` Returns the type of the Cell as an int TYPE_STRING = 0, TYPE_FP = 1, TYPE_INT = 2, TYPE_FORMULA = 3, TYPE_BOOLEAN = 4, TYPE_DOUBLE = 5;
`String`	`getCellTypeName()` returns the java Type string of the Cell One of: "String" "Float" "Integer" "Formula" "Double"
`ColHandle`	`getCol()` Returns the ColHandle for the Cell.
`int`	`getColNum()` Returns the column number of this Cell.
`CommentHandle`	`getComment()` Get a CommentHandle to the note attached to this cell
`ConditionalFormatHandle[]`	`getConditionalFormatHandles()` return all the ConditionalFormatHandles for this Cell, if any
`int`	`getConditionalFormatId()` get the conditional formatting record ID (FormatId) returns the normal FormatId if the condition(s) in the conditional format have not been met
`FormatHandle[]`	`getConditionallyFormattedHandles()` returns an array of FormatHandles for the Cell that have the current conditional format applied to them.
`Object`	`getDefaultVal()` Get the default "empty" data value for this CellHandle
`double`	`getDoubleVal()` returns the value of this Cell as a double, if possible, or NaN if Cell value cannot be converted to double
`protected static String`	`getEmptyCellXML(String loc, boolean isVisible)` Returns an xml representation of an empty cell
`int`	`getFillPattern()` get the fill pattern for this cell Same as getBackgroundPattern
`float`	`getFloatVal()` returns the value of this Cell as a float, if possible, or NaN if Cell value cannot be converted to float
`Font`	`getFont()` Get the OpenXLS Font for this Cell, which roughly matches the functionality of the java.awt.Font class.
`Color`	`getFontColor()` get the Color of the Font used by this Cell.
`String`	`getFontFace()` get the Font face used by this Cell.
`int`	`getFontSize()` get the size in points of the Font used by this Cell
`int`	`getFontWeight()` get the weight (boldness) of the Font used by this Cell.
`Color`	`getForegroundColor()` get the Color of the Cell Foreground of this Cell and all other cells sharing this FormatId.
`FormatHandle`	`getFormatHandle()` Gets the FormatHandle (a Format Object describing the formats for this Cell) for this Cell.
`int`	`getFormatId()` Returns the Formatting record ID (FormatId) for this Cell This can be used with 'setFormatId(int i)' to copy the formatting from one Cell to another (e.g.
`String`	`getFormatPattern()` Gets the number format pattern for this cell, if set.
`String`	`getFormattedStringVal()` Gets the value of the cell as a String with the number format applied.
`String`	`getFormattedStringVal(boolean formatForXML)` Gets the value of the cell as a String with the number format applied.
`FormulaHandle`	`getFormulaHandle()` Returns the Formula Handle (an Object describing a Formula) for this Cell, if it contains a formula
`int`	`getHorizontalAlignment()` Returns an int representing the current horizontal alignment in this Cell.
`int[]`	`getIntLocation()`
`int`	`getIntVal()` returns the value of this Cell as a int, if possible, or NaN if Cell value cannot be converted to int
`boolean`	`getIsUnderlined()` returns whether the Font for this Cell is underlined
`String`	`getJSON()` Get the JSON object for this cell.
`org.json.JSONObject`	`getJSONObject()` Get the JSON object for this cell.
`org.json.JSONObject`	`getJSONObject(int[] mergedRange)` Deprecated. The `mergedRange` parameter is unnecessary. This method will be removed in a future version. Use `getJSONObject()` instead.
`CellRange`	`getMergedCellRange()` Returns any other Cells merged with this one, or null if this Cell is not a part of a merged range.
`XLSRecord`	`getRecord()` returns the underlying BIFF8 record for the Cell NOTE: the underlying record is not a part of the public API and may change at any time.
`RowHandle`	`getRow()` Returns the RowHandle for the Cell.
`int`	`getRowNum()` Returns the row number of this Cell.
`int`	`getSheetNum()` get the index of the WorkSheet containing this Cell in the list of sheets
`int[]`	`getSpan(int row, int column)` Deprecated. since October 2012. This method duplicates the functionality of `getMergedCellRange()`, which it calls internally. That method should be used instead.
`String`	`getStringVal()` Returns the value of the Cell as a String.
`String`	`getStringVal(int notation)` Returns the value of the Cell as a String.
`String`	`getStringVal(String encoding)` Returns the value of the Cell as a String with the specified encoding.
`String`	`getURL()` Returns the Hyperlink URL String for this Cell, if any
`String`	`getURLDescription()` Returns the URL Description String for this Cell, if any
`Object`	`getVal()` Returns the value of this Cell in the native underlying data type.
`ValidationHandle`	`getValidationHandle()` Returns the validation handle for the cell.
`int`	`getVerticalAlignment()` Returns an int representing the current vertical alignment in this Cell.
`WorkBook`	`getWorkBook()` returns the WorkBookHandle for this Cell
`WorkSheetHandle`	`getWorkSheetHandle()` get the WorkSheetHandle for this Cell
`String`	`getWorkSheetName()` Returns the name of this Cell's WorkSheet as a String.
`boolean`	`getWrapText()` Get the cell wrapping behavior for this cell.
`String`	`getXML()` Returns an XML representation of the cell and it's component data
`String`	`getXML(int[] mergedRange)` Returns an XML representation of the cell and it's component data
`int`	`hashCode()`
`boolean`	`hasHyperlink()` returns true if this Cell contains a hyperlink
`boolean`	`isBlank()` Returns whether this is a blank cell.
`boolean`	`isCurrency()` Returns whether this Cell has a Currency format applied.
`boolean`	`isDate()` Returns whether this Cell has Date formatting applied.
`boolean`	`isDefaultCell()` Determines if the cellHandle represents a completely blank/null cell, and can thus be ignored for many operations.
`boolean`	`isFormula()` Returns whether this cell is a formula.
`boolean`	`isFormulaHidden()` Returns whether the formula for the Cell is hidden
`boolean`	`isLocked()` returns whether this Cell is locked for editing
`boolean`	`isMergeParent()` Returns if the Cell is the parent (cell containing display value) of a merged cell range.
`boolean`	`isNumber()` Returns whether this Cell has a numeric value
`void`	`moveAndOverwriteTo(String newaddr)` move this cell to another location, overwriting any cells that are in the way
`void`	`moveAndOverwriteToRow(int newrow)` move this cell to another row overwrite any cells in the destination
`void`	`moveTo(String newaddr)` move this cell to another location.
`void`	`moveToCol(String newcol)` move this cell to another column throws CellPositionConflictException if there is a cell in that position already
`void`	`moveToRow(int newrow)` move this cell to another row throws CellPositionConflictException if there is a cell in that position already
`void`	`remove(boolean nullme)` Removes this Cell from the WorkSheet
`void`	`removeBorder()` removes the borders for this cell
`void`	`removeComment()` Removes any note/comment records attached to this cell
`void`	`setBackgroundColor(Color col)` set the Color of the Cell Background pattern for this Cell.
`void`	`setBackgroundColor(int t)` set the Background Color for this Cell.
`void`	`setBackgroundPattern(int t)` set the Background Pattern for this Cell.
`void`	`setBlankRef(int c)`
`void`	`setBold(boolean bold)` Convenience method for toggling the bold state of the Font used by this Cell.
`void`	`setBorderBottomColor(Color col)` set the Color of the bottom Border line for this Cell.
`void`	`setBorderColor(Color col)` set the Color of the Border for this Cell.
`void`	`setBorderLeftColor(Color col)` set the Color of the left Border line for this Cell.
`void`	`setBorderLineStyle(short s)` set the Border line style for this Cell.
`void`	`setBorderRightColor(Color col)` set the Color of the right Border line for this Cell.
`void`	`setBorderTopColor(Color col)` set the Color of the top Border line for this Cell.
`void`	`setBottomBorderLineStyle(short s)` set the Bottom Border line style for this Cell.
`void`	`setCellBackgroundColor(Color col)` set the Color of the Cell Background for this Cell.
`void`	`setCellBackgroundColor(int t)` set the Color of the Cell Background for this Cell.
`void`	`setCellRotation(int align)` Set the rotation of the cell in degrees.
`void`	`setFileURL(String fileURLStr)` Sets a hyperlink to a location within the current template The URL String should be prefixed with "file://"
`void`	`setFileURL(String fileURLstr, String desc, String textMark)` Sets a hyperlink to a location within the current template, and includes additional optional information: description + textMark text The URL String should be prefixed with "file://" The textMark text is the porition of the URL that follows #
`void`	`setFont(String fn, int stl, int sz)` Set the Font for this Cell via font name, font style and font size This method adds a new Font to the WorkBook.
`void`	`setFontColor(Color col)` Set the color of the Font used by this Cell.
`void`	`setFontColor(int t)` set the Font Color for this Cell see FormatHandle.COLOR constants for valid values
`void`	`setFontFace(String fn)` set the Font face used by this Cell.
`void`	`setFontSize(int sz)` change the size (in points) of the Font used by this Cell and all other Cells sharing this FormatId.
`void`	`setFontWeight(int wt)` change the weight (boldness) of the Font used by this Cell.
`void`	`setForeColor(int i)` set the Foreground Color for this Cell NOTE: this is the PATTERN Color
`void`	`setForegroundColor(Color col)` sets the Color of the Cell Foreground pattern for this Cell.
`void`	`setForegroundColor(int t)` set the Foreground Color for this Cell.
`void`	`setFormatHandle(FormatHandle f)` Sets the FormatHandle (a Format Object describing the formats for this Cell) for this Cell
`void`	`setFormatId(int i)` Sets the Formatting record ID (FormatId) for this Cell This can be used with 'getFormatId()' to copy the formatting from one Cell to another (ie: a template cell to a new cell)
`void`	`setFormatPattern(String pat)` Sets the number format pattern for this cell.
`void`	`setFormula(Stack<?> newExp, Object value)` sets the formula for this cellhandle using a stack of Ptgs appropriate for formula records.
`void`	`setFormula(String formStr)` Set a cell to Excel-compatible formula passed in as String.
`void`	`setFormula(String formStr, Object value)` Set a cell to formula passed in as String.
`void`	`setFormulaHidden(boolean hidden)` Hides or shows the formula for this Cell, if present
`void`	`setHorizontalAlignment(int align)` Set the horizontal alignment for this Cell
`void`	`setLeftBorderLineStyle(short s)` set the Left Border line style for this Cell.
`void`	`setLocked(boolean locked)` locks or unlocks this Cell for editing
`void`	`setPatternBackgroundColor(Color col)` set the Color of the Cell Background Pattern for this Cell.
`void`	`setRecord(XLSRecord rec)` sets the underlying BIFF8 record for the Cell NOTE: the underlying record is not a part of the public API and may change at any time.
`void`	`setRightBorderLineStyle(short s)` set the Right Border line style for this Cell.
`void`	`setScript(int ss)` Set the super/sub script for the Font
`void`	`setStringVal(String s)` set the value of this cell to String s NOTE: this method will not check for formula references or do any data conversions This method is useful when a string may start with = but you do not want to convert to a Formula value If you wish to put a line break in the string use the newline "\n" character.
`void`	`setStringVal(Unicodestring us)` set the value of this cell to Unicodestring us NOTE: This method will not check for formula references or do any data conversions Useful when strings may start with = but you do not want to convert to a formula value
`void`	`setToDefault()` Sets a default "empty" value appropriate for the cell type of this CellHandle For example, will set the value to 0.0 for TYPE_DOUBLE, an empty String for TYPE_BLANK
`void`	`setTopBorderLineStyle(short s)` set the Top Border line style for this Cell.
`void`	`setUnderlined(boolean isUnderlined)` Set whether the Font for this Cell is underlined
`void`	`setURL(String urlstr)` Creates a new Hyperlink for this Cell from a URL String.
`void`	`setURL(String urlstr, String desc, String textMark)` Creates a new Hyperlink for this Cell from a URL String, a descrpiton and textMark text.
`void`	`setVal(boolean b)` Sets the value of this Cell to a boolean value
`void`	`setVal(Date dt, String fmt)` Sets the value of this Cell to a java.sql.Date.
`void`	`setVal(double d)` Set the Value of the Cell to a double
`void`	`setVal(float f)` Set value of this Cell to a Float
`void`	`setVal(int i)` Set the value of this Cell to an int value NOTE: setting a Boolean Cell type to a zero or a negative number will set the Cell to 'false'; setting it to an int value 1 or greater will set it to true.
`void`	`setVal(Object obj)` Set the val of this Cell to an object The object may be one of type: String, Float, Integer, Double, Long, Boolean, java.sql.Date, or null To set a Cell to a formula, obj should be a string begining with "=" To set a Cell to an array formula, obj should be a string begining with "{=" If you wish to put a line break in a string value, use the newline "\n" character.
`void`	`setVerticalAlignment(int align)` Set the Vertical alignment for this Cell
`void`	`setWorkSheetHandle(WorkSheetHandle handle)` set the WorkSheetHandle for this Cell
`void`	`setWrapText(boolean wrapit)` Sets the cell wrapping behavior for this cell
`String`	`toString()` Returns a String representation of this CellHandle

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - TYPE_BLANK
```
public static final int TYPE_BLANK
```
    Cell types
    
    See Also:
    
    Constant Field Values
  - TYPE_STRING
```
public static final int TYPE_STRING
```
    See Also:
    
    Constant Field Values
  - TYPE_FP
```
public static final int TYPE_FP
```
    See Also:
    
    Constant Field Values
  - TYPE_INT
```
public static final int TYPE_INT
```
    See Also:
    
    Constant Field Values
  - TYPE_FORMULA
```
public static final int TYPE_FORMULA
```
    See Also:
    
    Constant Field Values
  - TYPE_BOOLEAN
```
public static final int TYPE_BOOLEAN
```
    See Also:
    
    Constant Field Values
  - TYPE_DOUBLE
```
public static final int TYPE_DOUBLE
```
    See Also:
    
    Constant Field Values
  - NOTATION_STANDARD
```
public static final int NOTATION_STANDARD
```
    See Also:
    
    Constant Field Values
  - NOTATION_SCIENTIFIC
```
public static final int NOTATION_SCIENTIFIC
```
    See Also:
    
    Constant Field Values
  - NOTATION_SCIENTIFIC_EXCEL
```
public static final int NOTATION_SCIENTIFIC_EXCEL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CellHandle
```
public CellHandle(BiffRec c)
```
    Public Constructor added for use in Bean-context ONLY. Do NOT create CellHandles manually.
  - CellHandle
```
public CellHandle(BiffRec c,
                  WorkBook myb)
```
    Public Constructor added for use in Bean-context ONLY. Do NOT create CellHandles manually.
- Method Detail
  - getRecord
```
public XLSRecord getRecord()
```
    returns the underlying BIFF8 record for the Cell
    NOTE: the underlying record is not a part of the public API and may change at any time.
    
    Returns:
    
    Returns the underlying biff record.
  - setRecord
```
public void setRecord(XLSRecord rec)
```
    sets the underlying BIFF8 record for the Cell
    NOTE: the underlying record is not a part of the public API and may change at any time.
    
    Parameters:
    
    XLSRecord - rec - The BIFF record to set.
  - setToDefault
```
public void setToDefault()
```
    Sets a default "empty" value appropriate for the cell type of this CellHandle
    For example, will set the value to 0.0 for TYPE_DOUBLE, an empty String for TYPE_BLANK
  - getDefaultVal
```
public Object getDefaultVal()
```
    Get the default "empty" data value for this CellHandle
    
    Returns:
    
    Object a default empty value corresponding to the cell type
    such as 0.0 for TYPE_DOUBLE or an empty String for TYPE_BLANK
  - setFormatPattern
```
public void setFormatPattern(String pat)
```
    Sets the number format pattern for this cell. All Excel built-in number formats are supported. Custom formats will not be applied by OpenXLS (e.g. the getFormattedStringVal() method) but they will be written correctly to the output file. For more information on number format patterns see Microsoft KB264372.
    
    Parameters:
    
    pat - the Excel number format pattern to apply
    
    See Also:
    
    FormatConstantsImpl.getBuiltinFormats()
  - getFormatPattern
```
public String getFormatPattern()
```
    Gets the number format pattern for this cell, if set. For more information on number format patterns see Microsoft KB264372.
    
    Returns:
    
    the Excel number format pattern for this cell or null if none is applied
  - isDate
```
public boolean isDate()
```
    Returns whether this Cell has Date formatting applied.
    NOTE: This does not guarantee that the value is a valid date.
    
    Specified by:
    
    isDate in interface Cell
    
    Returns:
    
    boolean true if this Cell has a Date Format applied
  - isFormula
```
public boolean isFormula()
```
    Returns whether this cell is a formula.
  - isFormulaHidden
```
public boolean isFormulaHidden()
```
    Returns whether the formula for the Cell is hidden
    
    Returns:
    
    boolean true if formula is hidden
  - isLocked
```
public boolean isLocked()
```
    returns whether this Cell is locked for editing
    
    Returns:
    
    boolean true if the cell is locked
  - isBlank
```
public boolean isBlank()
```
    Returns whether this is a blank cell.
    
    Returns:
    
    true if this cell is blank
  - isCurrency
```
public boolean isCurrency()
```
    Returns whether this Cell has a Currency format applied.
    
    Returns:
    
    boolean true if this Cell has a Currency format applied
  - isNumber
```
public boolean isNumber()
```
    Returns whether this Cell has a numeric value
    
    Returns:
    
    boolean true if this Cell contains a numeric value
  - setFontSize
```
public void setFontSize(int sz)
```
    change the size (in points) of the Font used by this Cell and all other Cells sharing this FormatId.
    NOTE: To add an entirely new Font use the setFont(String fn, int typ, int sz) method instead.
    
    Parameters:
    
    int - sz - Font size in Points.
  - setFontWeight
```
public void setFontWeight(int wt)
```
    change the weight (boldness) of the Font used by this Cell.
    Some examples:
    a weight of 200 is normal
    a weight of 700 is bold
    
    Parameters:
    
    int - wt - Font weight range between 100-1000
  - setBold
```
public void setBold(boolean bold)
```
    Convenience method for toggling the bold state of the Font used by this Cell.
    
    Parameters:
    
    boolean - bold - true if bold
  - getFontWeight
```
public int getFontWeight()
```
    get the weight (boldness) of the Font used by this Cell.
    
    Returns:
    
    int Font weight range between 100-1000
  - getFontSize
```
public int getFontSize()
```
    get the size in points of the Font used by this Cell
    
    Returns:
    
    int Font size in Points.
  - getFontColor
```
public Color getFontColor()
```
    get the Color of the Font used by this Cell.
    
    Returns:
    
    int Excel color constant for Font color
    
    See Also:
    
    constants
  - setFontColor
```
public void setFontColor(Color col)
```
    Set the color of the Font used by this Cell.
    
    Parameters:
    
    java - .Awt.Color col - color of the font
  - setForegroundColor
```
public void setForegroundColor(int t)
```
    set the Foreground Color for this Cell.
    
    NOTE: Foreground color is the CELL BACKGROUND color for all patterns and Background color is the PATTERN color for all patterns not equal to PATTERN_SOLID
    For PATTERN_SOLID, the Foreground color is the CELL BACKGROUND color and Background Color is 64 (white).
    
    Parameters:
    
    int - t - Excel color constant
    
    See Also:
    
    constants
  - setForeColor
```
public void setForeColor(int i)
```
    set the Foreground Color for this Cell
    NOTE: this is the PATTERN Color
    
    Parameters:
    
    int - Excel color constant
    
    See Also:
    
    constants
  - setBackgroundColor
```
public void setBackgroundColor(int t)
```
    set the Background Color for this Cell.
    
    NOTE: Foreground color is the CELL BACKGROUND color for all patterns and Background color is the PATTERN color for all patterns not equal to PATTERN_SOLID
    For PATTERN_SOLID, the Foreground color is the CELL BACKGROUND color and Background Color is 64 (white).
    
    Parameters:
    
    int - t - Excel color constant
    
    See Also:
    
    constants
  - getForegroundColor
```
public Color getForegroundColor()
```
    get the Color of the Cell Foreground of this Cell and all other cells sharing this FormatId.
    
    NOTE: Foreground color is the CELL BACKGROUND color for all patterns and Background color is the PATTERN color for all patterns not equal to PATTERN_SOLID
    For PATTERN_SOLID, the Foreground color is the CELL BACKGROUND color and Background Color is 64 (white).
    
    Returns:
    
    java.awt.Color of the Font
  - setForegroundColor
```
public void setForegroundColor(Color col)
```
    sets the Color of the Cell Foreground pattern for this Cell.
    
    NOTE: Foreground color is the CELL BACKGROUND color for all patterns and Background color is the PATTERN color for all patterns not equal to PATTERN_SOLID
    For PATTERN_SOLID, the Foreground color is the CELL BACKGROUND color and Background Color is 64 (white).
    
    Parameters:
    
    java - .awt.Color col - color for the foreground
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    get the Color of the Cell Background by this Cell and all other cells sharing this FormatId.
    
    NOTE: Foreground color is the CELL BACKGROUND color for all patterns and Background color is the PATTERN color for all patterns not equal to PATTERN_SOLID
    For PATTERN_SOLID, the Foreground color is the CELL BACKGROUND color and Background Color is 64 (white).
    
    Returns:
    
    java.awt.Color for the Font
  - getCellBackgroundColor
```
public Color getCellBackgroundColor()
```
    Return the cell background color i.e. the color if a pattern is set, or white if none
    
    Returns:
    
    java.awt.Color cell background color
  - setBackgroundColor
```
public void setBackgroundColor(Color col)
```
    set the Color of the Cell Background pattern for this Cell.
    
    NOTE: Foreground color is the CELL BACKGROUND color for all patterns and Background color is the PATTERN color for all patterns not equal to PATTERN_SOLID
    For PATTERN_SOLID, the Foreground color is the CELL BACKGROUND color and Background Color is 64 (white).
    
    Parameters:
    
    java - .awt.Color col - background color
  - setCellBackgroundColor
```
public void setCellBackgroundColor(int t)
```
    set the Color of the Cell Background for this Cell.
    
    see FormatHandle.COLOR constants for valid values
    
    NOTE: Foreground color is the CELL BACKGROUND color for all patterns and Background color is the PATTERN color for all patterns not equal to PATTERN_SOLID
    For PATTERN_SOLID, the Foreground color is the CELL BACKGROUND color and Background Color is 64 (white).
    
    Parameters:
    
    int - t - Excel color constant for Cell Background color
  - setCellBackgroundColor
```
public void setCellBackgroundColor(Color col)
```
    set the Color of the Cell Background for this Cell.
    
    NOTE: Foreground color is the CELL BACKGROUND color for all patterns and Background color is the PATTERN color for all patterns not equal to PATTERN_SOLID
    For PATTERN_SOLID, the Foreground color is the CELL BACKGROUND color and Background Color is 64 (white).
    
    Parameters:
    
    java - .awt.Color col - color of the cell background
  - setPatternBackgroundColor
```
public void setPatternBackgroundColor(Color col)
```
    set the Color of the Cell Background Pattern for this Cell.
    
    Parameters:
    
    java - .awt.Color col - color of the pattern background
  - setBackgroundPattern
```
public void setBackgroundPattern(int t)
```
    set the Background Pattern for this Cell.
    
    Parameters:
    
    int - t - Excel pattern constant
    
    See Also:
    
    constants
  - getBackgroundPattern
```
public int getBackgroundPattern()
```
    get the Background Pattern for this cell
    
    Returns:
    
    int Excel pattern constant
    
    See Also:
    
    constants
  - getFillPattern
```
public int getFillPattern()
```
    get the fill pattern for this cell
    Same as getBackgroundPattern
    
    Returns:
    
    int Excel fill pattern constant
    
    See Also:
    
    constants
  - setBorderColor
```
public void setBorderColor(Color col)
```
    set the Color of the Border for this Cell.
    
    Parameters:
    
    java - .awt.Color col - border color
  - setBorderRightColor
```
public void setBorderRightColor(Color col)
```
    set the Color of the right Border line for this Cell.
    
    Parameters:
    
    java - .awt.Color col - right border color
  - setBorderLeftColor
```
public void setBorderLeftColor(Color col)
```
    set the Color of the left Border line for this Cell.
    
    Parameters:
    
    java - .awt.Color col - left border color
  - setBorderTopColor
```
public void setBorderTopColor(Color col)
```
    set the Color of the top Border line for this Cell.
    
    Parameters:
    
    java - .awt.Color col - top border color
  - setBorderBottomColor
```
public void setBorderBottomColor(Color col)
```
    set the Color of the bottom Border line for this Cell.
    
    Parameters:
    
    java - .awt.Color col - bottom border color
  - getFontFace
```
public String getFontFace()
```
    get the Font face used by this Cell.
    
    Returns:
    
    String the system name of the font for this Cell
  - setFontFace
```
public void setFontFace(String fn)
```
    set the Font face used by this Cell.
    
    Parameters:
    
    String - fn - system name of the font
  - setBorderLineStyle
```
public void setBorderLineStyle(short s)
```
    set the Border line style for this Cell.
    
    Parameters:
    
    short - s - border constant
    
    See Also:
    
    line style constants
  - setRightBorderLineStyle
```
public void setRightBorderLineStyle(short s)
```
    set the Right Border line style for this Cell.
    
    Parameters:
    
    short - s - border constant
    
    See Also:
    
    line style constants
  - setLeftBorderLineStyle
```
public void setLeftBorderLineStyle(short s)
```
    set the Left Border line style for this Cell.
    
    Parameters:
    
    short - s - border constant
    
    See Also:
    
    line style constants
  - setTopBorderLineStyle
```
public void setTopBorderLineStyle(short s)
```
    set the Top Border line style for this Cell.
    
    Parameters:
    
    short - s - border constant
    
    See Also:
    
    line style constants
  - setBottomBorderLineStyle
```
public void setBottomBorderLineStyle(short s)
```
    set the Bottom Border line style for this Cell.
    
    Parameters:
    
    short - s - border constant
    
    See Also:
    
    line style constants
  - removeBorder
```
public void removeBorder()
```
    removes the borders for this cell
  - getFont
```
public Font getFont()
```
    Get the OpenXLS Font for this Cell, which roughly matches the functionality of the java.awt.Font class.
    Due to awt problems on console systems, converting the OpenXLS font to a GUI font is up to you.
    
    Returns:
    
    OpenXLS font for Cell
  - getAwtFont
```
public Font getAwtFont()
```
    convert the OpenXLS font used by this Cell to java.awt.Font
    
    Returns:
    
    java.awt.Font for this cell
  - setFont
```
public void setFont(String fn,
                    int stl,
                    int sz)
```
    Set the Font for this Cell via font name, font style and font size
    This method adds a new Font to the WorkBook.
    Roughly matches the functionality of the java.awt.Font class.
    
    Parameters:
    
    String - fn - system name of the font e.g. "Arial"
    
    int - stl - font style (either Font.BOLD or Font.PLAIN)
    
    int - sz - font size in points
  - getComment
```
public CommentHandle getComment()
                         throws DocumentObjectNotFoundException
```
    Get a CommentHandle to the note attached to this cell
    
    Throws:
    
    DocumentObjectNotFoundException
  - removeComment
```
public void removeComment()
```
    Removes any note/comment records attached to this cell
  - createComment
```
public CommentHandle createComment(String comment,
                                   String author)
```
    Creates a new annotation (Note or Comment) to the cell
    
    Parameters:
    
    comment - -- text of note
    
    author - -- name of author
    
    Returns:
    
    CommentHandle - handle which allows access to the Note object
    
    See Also:
    
    CommentHandle
  - getIsUnderlined
```
public boolean getIsUnderlined()
```
    returns whether the Font for this Cell is underlined
    
    Returns:
    
    boolean true if Font is underlined
  - setUnderlined
```
public void setUnderlined(boolean isUnderlined)
```
    Set whether the Font for this Cell is underlined
    
    Parameters:
    
    boolean - b - true if the Font for this Cell should be underlined (single underline only)
  - setFontColor
```
public void setFontColor(int t)
```
    set the Font Color for this Cell
    
    see FormatHandle.COLOR constants for valid values
    
    Parameters:
    
    int - t - Excel color constant
  - getMergedCellRange
```
public CellRange getMergedCellRange()
```
    Returns any other Cells merged with this one, or null if this Cell is not a part of a merged range.
    Adding and/or removing Cells from this CellRange will merge or unmerge the Cells.
    
    Returns:
    
    CellRange object containing all Cells in this Cell's merged range.
  - isMergeParent
```
public boolean isMergeParent()
```
    Returns if the Cell is the parent (cell containing display value) of a merged cell range.
    
    Returns:
    
    boolean true if this cell is a merge parent cell
  - getCol
```
public ColHandle getCol()
```
    Returns the ColHandle for the Cell.
    
    Returns:
    
    ColHandle for the Cell
  - getRow
```
public RowHandle getRow()
```
    Returns the RowHandle for the Cell.
    
    Returns:
    
    RowHandle representing the Row for the Cell
  - getVal
```
public Object getVal()
```
    Returns the value of this Cell in the native underlying data type. Formula cells will return the calculated value of the formula in the calculated data type. Use 'getStringVal()' to return a String regardless of underlying value type.
    
    Specified by:
    
    getVal in interface Cell
    
    Returns:
    
    Object value for this Cell
  - getCellTypeName
```
public String getCellTypeName()
```
    returns the java Type string of the Cell
    One of:
  - "String"
  - "Float"
  - "Integer"
  - "Formula"
  - "Double"

Returns:: String java data type

getCellType
```
public int getCellType()
```
Returns the type of the Cell as an int
TYPE_STRING = 0,
TYPE_FP = 1,
TYPE_INT = 2,
TYPE_FORMULA = 3,
TYPE_BOOLEAN = 4,
TYPE_DOUBLE = 5;

Class CellHandle

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_BLANK

TYPE_STRING

TYPE_FP

TYPE_INT

TYPE_FORMULA

TYPE_BOOLEAN

TYPE_DOUBLE

NOTATION_STANDARD

NOTATION_SCIENTIFIC

NOTATION_SCIENTIFIC_EXCEL

Constructor Detail

CellHandle

CellHandle

Method Detail

getRecord

setRecord

setToDefault

getDefaultVal

setFormatPattern

getFormatPattern

isDate

isFormula

isFormulaHidden

isLocked

isBlank

isCurrency

isNumber

setFontSize

setFontWeight

setBold

getFontWeight

getFontSize

getFontColor

setFontColor

setForegroundColor

setForeColor

setBackgroundColor

getForegroundColor

setForegroundColor

getBackgroundColor

getCellBackgroundColor

setBackgroundColor

setCellBackgroundColor

setCellBackgroundColor

setPatternBackgroundColor

setBackgroundPattern

getBackgroundPattern

getFillPattern

setBorderColor

setBorderRightColor

setBorderLeftColor

setBorderTopColor

setBorderBottomColor

getFontFace

setFontFace

setBorderLineStyle

setRightBorderLineStyle

setLeftBorderLineStyle

setTopBorderLineStyle

setBottomBorderLineStyle

removeBorder

getFont

getAwtFont

setFont

getComment

removeComment

createComment

getIsUnderlined

setUnderlined

setFontColor

getMergedCellRange

isMergeParent

getCol

getRow