xl.write
Class DateTime

System.Object
  extended byxl.biff.RecordData
      extended byxl.biff.WritableRecordData
          extended byxl.write.biff.CellValue
              extended byxl.write.biff.DateRecord
                  extended byxl.write.DateTime
All Implemented Interfaces:
xl.biff.ByteData, Cell, DateCell, WritableCell

public class DateTime
extends xl.write.biff.DateRecord
implements WritableCell, DateCell

A Date which may be created on the fly by a user application and added to a spreadsheet NOTE: By default, all dates will have local timezone information added to their UTC value. If this is not desired (eg. if the date entered represents an interval eg. 9.83s for the 100m world record, then use the overloaded constructor which indicate that the date passed in was created under the GMT timezone. It is important that when the date was created, an instruction like Calendar.setTimeZone(TimeZone.getTimeZone("GMT")) was made prior to that


Field Summary
static xl.write.biff.DateRecord.GMTDate GMT
          Instance variable for dummy variable overload
 
Constructor Summary
DateTime(DateCell dc)
          A constructor called by the worksheet when creating a writable version of a spreadsheet that has been read in
DateTime(int c, int r, System.DateTime d)
          Constructor
DateTime(int c, int r, System.DateTime d, CellFormat st)
          Constructor which takes the format for this cell
DateTime(int c, int r, System.DateTime d, CellFormat st, boolean tim)
          Constructor which takes the format for the cell and an indicator as to whether this cell is a full date time or purely just a time eg.
DateTime(int c, int r, System.DateTime d, CellFormat st, xl.write.biff.DateRecord.GMTDate a)
          Constructor, which adjusts the specified date to take time zone considerations into account
DateTime(int c, int r, System.DateTime d, xl.write.biff.DateRecord.GMTDate a)
          Constructor, which adjusts the specified date to take time zone considerations into account
 
Method Summary
 WritableCell copyTo(int col, int row)
          Implementation of the deep copy function
 void setDate(System.DateTime d)
          Sets the date for this cell
 void setDate(System.DateTime d, xl.write.biff.DateRecord.GMTDate a)
          Sets the date for this cell, performing the necessary time zone adjustments
 
Methods inherited from class xl.write.biff.DateRecord
getContents, getData, getDate, getDateFormat, getType, isTime
 
Methods inherited from class xl.write.biff.CellValue
addCellFeatures, getCellFeatures, getCellFormat, getColumn, getRow, getWritableCellFeatures, isHidden, removeComment, setCellFeatures, setCellFormat
 
Methods inherited from class xl.biff.WritableRecordData
getBytes
 
Methods inherited from class System.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface xl.write.WritableCell
getWritableCellFeatures, setCellFeatures, setCellFormat
 
Methods inherited from interface xl.Cell
getCellFeatures, getCellFormat, getColumn, getContents, getRow, getType, isHidden
 
Methods inherited from interface xl.DateCell
getDate, getDateFormat, isTime
 

Field Detail

GMT

public static readonly xl.write.biff.DateRecord.GMTDate GMT
Instance variable for dummy variable overload

Constructor Detail

DateTime

public DateTime(int c,
                int r,
                System.DateTime d)
Constructor

Parameters:
c - the column
r - the row
d - the date

DateTime

public DateTime(int c,
                int r,
                System.DateTime d,
                xl.write.biff.DateRecord.GMTDate a)
Constructor, which adjusts the specified date to take time zone considerations into account

Parameters:
c - the column
r - the row
d - the date
a - dummy overload

DateTime

public DateTime(int c,
                int r,
                System.DateTime d,
                CellFormat st)
Constructor which takes the format for this cell

Parameters:
c - the column
r - the row
st - the format
d - the date

DateTime

public DateTime(int c,
                int r,
                System.DateTime d,
                CellFormat st,
                xl.write.biff.DateRecord.GMTDate a)
Constructor, which adjusts the specified date to take time zone considerations into account

Parameters:
c - the column
r - the row
d - the date
st - the cell format
a - the cummy overload

DateTime

public DateTime(int c,
                int r,
                System.DateTime d,
                CellFormat st,
                boolean tim)
Constructor which takes the format for the cell and an indicator as to whether this cell is a full date time or purely just a time eg. if the spreadsheet is to contain the world record for 100m, then the value would be 9.83s, which would be indicated as just a time

Parameters:
c - the column
r - the row
st - the style
tim - flag indicating that this represents a time
d - the date

DateTime

public DateTime(DateCell dc)
A constructor called by the worksheet when creating a writable version of a spreadsheet that has been read in

Parameters:
dc - the date to copy
Method Detail

setDate

public void setDate(System.DateTime d)
Sets the date for this cell

Parameters:
d - the date

setDate

public void setDate(System.DateTime d,
                    xl.write.biff.DateRecord.GMTDate a)
Sets the date for this cell, performing the necessary time zone adjustments

Parameters:
d - the date
a - the dummy overload

copyTo

public WritableCell copyTo(int col,
                           int row)
Implementation of the deep copy function

Specified by:
copyTo in interface WritableCell
Parameters:
col - the column which the new cell will occupy
row - the row which the new cell will occupy
Returns:
a copy of this cell, which can then be added to the sheet