Save This Page
Home » jexcelapi_2_6_8 » jxl.write.biff » [javadoc | source]
jxl.write.biff
abstract public class: CellValue [javadoc | source]
java.lang.Object
   jxl.biff.RecordData
      jxl.biff.WritableRecordData
         jxl.write.biff.CellValue

All Implemented Interfaces:
    WritableCell, ByteData

Direct Known Subclasses:
    ReadNumberFormulaRecord, Formula, BooleanRecord, BlankRecord, ReadDateFormulaRecord, LabelRecord, ReadFormulaRecord, FormulaRecord, NumberRecord, ReadErrorFormulaRecord, ReadBooleanFormulaRecord, DateRecord, Blank, Number, ReadStringFormulaRecord, Boolean, Label, DateTime

Abstract class which stores the common data used for cells, such as row, column and formatting information. Any record which directly represents the contents of a cell, such as labels and numbers, are derived from this class data store
Fields inherited from jxl.biff.WritableRecordData:
maxRecordLength
Constructor:
 protected CellValue(Type t,
    Cell c) 
    Constructor used when creating a writable cell from a read-only cell (when copying a workbook)
    Parameters:
    c - the cell to clone
    t - the type of this cell
 protected CellValue(Type t,
    int c,
    int r) 
    Constructor used when building writable cells from the Java API
    Parameters:
    c - the column
    t - the type indicator
    r - the row
 protected CellValue(Type t,
    int c,
    int r,
    CellFormat st) 
    Overloaded constructor used when building writable cells from the Java API which also takes a format
    Parameters:
    c - the column
    t - the cell type
    r - the row
    st - the format to apply to this cell
 protected CellValue(Type t,
    int c,
    int r,
    CellValue cv) 
    Copy constructor
    Parameters:
    c - the column
    t - the cell type
    r - the row
    cv - the value to copy
Method from jxl.write.biff.CellValue Summary:
addCellFeatures,   columnInserted,   columnRemoved,   decrementColumn,   decrementRow,   getCellFeatures,   getCellFormat,   getColumn,   getData,   getRow,   getSheet,   getWritableCellFeatures,   getXFIndex,   incrementColumn,   incrementRow,   isHidden,   isReferenced,   removeCellFeatures,   removeComment,   removeDataValidation,   rowInserted,   rowRemoved,   setCellDetails,   setCellFeatures,   setCellFormat,   setCopied
Methods from jxl.biff.WritableRecordData:
getBytes,   getData
Methods from jxl.biff.RecordData:
getCode,   getRecord
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from jxl.write.biff.CellValue Detail:
 public final  void addCellFeatures() 
    Handles any addition cell features, such as comments or data validation. Called internally from this class when a cell is added to the workbook, and also externally from BaseCellFeatures following a call to setComment
  void columnInserted(Sheet s,
    int sheetIndex,
    int col) 
    Called when a column is inserted on the specified sheet. Notifies all RCIR cells of this change. The default implementation here does nothing
  void columnRemoved(Sheet s,
    int sheetIndex,
    int col) 
    Called when a column is removed on the specified sheet. Notifies all RCIR cells of this change. The default implementation here does nothing
  void decrementColumn() 
    Decrements the column of this cell by one. Invoked by the sheet when removing columns
  void decrementRow() 
    Decrements the row of this cell by one. Invoked by the sheet when removing rows
 public CellFeatures getCellFeatures() 
    Accessor for the cell features
 public CellFormat getCellFormat() 
    API method which gets the format applied to this cell
 public int getColumn() 
    Returns the column number of this cell
 public byte[] getData() 
    Gets the data to write to the output file
 public int getRow() 
    Returns the row number of this cell
 protected WritableSheetImpl getSheet() 
    Accessor for the sheet containing this cell
 public WritableCellFeatures getWritableCellFeatures() 
    Accessor for the cell features
 final int getXFIndex() 
    Gets the internal index of the formatting record
  void incrementColumn() 
    Increments the column of this cell by one. Invoked by the sheet when inserting columns
  void incrementRow() 
    Increments the row of this cell by one. Invoked by the sheet when inserting rows
 public boolean isHidden() 
    Indicates whether or not this cell is hidden, by virtue of either the entire row or column being collapsed
 final boolean isReferenced() 
    Internal method to see if this cell is referenced within the workbook. Once this has been placed in the workbook, it becomes immutable
 public final  void removeCellFeatures() 
    Removes the cell features from the Workbook/Worksheet. Called when a cell is being removed/replaced from a worksheet
 public final  void removeComment(Comment c) 
    Called by the cell features to remove a comment
 public final  void removeDataValidation() 
    Called by the cell features to remove the data validation
  void rowInserted(Sheet s,
    int sheetIndex,
    int row) 
    Called when a row is inserted on the specified sheet. Notifies all RCIR cells of this change. The default implementation here does nothing
  void rowRemoved(Sheet s,
    int sheetIndex,
    int row) 
    Called when a row is inserted on the specified sheet. Notifies all RCIR cells of this change. The default implementation here does nothing
  void setCellDetails(FormattingRecords fr,
    SharedStrings ss,
    WritableSheetImpl s) 
    Called when the cell is added to the worksheet in order to indicate that this object is already added to the worksheet This method also verifies that the associated formats and formats have been initialized correctly
 public  void setCellFeatures(WritableCellFeatures cf) 
    Sets the cell features
 public  void setCellFormat(CellFormat cf) 
    An API function which sets the format to apply to this cell
 final  void setCopied(boolean c) 
    Called when doing a copy of a writable object to indicate the source was writable than a read only copy and certain things (most notably the comments will need to be re-evaluated)