jxl.biff
Class FormatRecord

java.lang.Object
  jxl.biff.RecordData
      jxl.biff.WritableRecordData
          jxl.biff.FormatRecord

All Implemented Interfaces:

ByteData, DisplayFormat, Format

Direct Known Subclasses:

DateFormatRecord, NumberFormatRecord

public class FormatRecord

extends WritableRecordData

implements DisplayFormat, Format

A non-built in format record

Field Summary

static jxl.biff.FormatRecord.BiffType	biff7
static jxl.biff.FormatRecord.BiffType	biff8
static Logger	logger The logger

Fields inherited from class jxl.biff.WritableRecordData

maxRecordLength

Constructor Summary

protected	FormatRecord() Constructor used by writable formats
protected	FormatRecord(FormatRecord fr) Copy constructor - can be invoked by public access
	FormatRecord(Record t, WorkbookSettings ws, jxl.biff.FormatRecord.BiffType biffType) Constructs this object from the raw data.

Method Summary

boolean	equals(java.lang.Object o) Standard equals method.
byte[]	getData() Used to get the data when writing out the format record
java.text.DateFormat	getDateFormat() Gets the java equivalent date format for the formatString
int	getFormatIndex() Gets the format index of this record
java.lang.String	getFormatString() Gets the formatting string.
int	getIndexCode() Gets the index code, for use as a hash value
java.text.NumberFormat	getNumberFormat() Gets the java equivalent number format for the formatString
int	hashCode() Standard hash code method
void	initialize(int pos) Sets the index of this record.
boolean	isBuiltIn() Indicates whether this formula is a built in
boolean	isDate() Sees if this format is a date format
boolean	isInitialized() Accessor to see whether this object is initialized or not.
boolean	isNumber() Sees if this format is a number format
protected java.lang.String	replace(java.lang.String input, java.lang.String search, java.lang.String replace) Replaces all instances of search with replace in the input.
protected void	setFormatString(java.lang.String s) Called by the immediate subclass to set the string once the Java-Excel replacements have been done

Methods inherited from class jxl.biff.WritableRecordData

getBytes

Methods inherited from class jxl.biff.RecordData

getCode, getRecord

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static Logger logger

The logger

biff8

public static final jxl.biff.FormatRecord.BiffType biff8

biff7

public static final jxl.biff.FormatRecord.BiffType biff7

Constructor Detail

FormatRecord

protected FormatRecord()

Constructor used by writable formats

FormatRecord

protected FormatRecord(FormatRecord fr)

Copy constructor - can be invoked by public access

Parameters:

fr - the format to copy

FormatRecord

public FormatRecord(Record t,
                    WorkbookSettings ws,
                    jxl.biff.FormatRecord.BiffType biffType)

Constructs this object from the raw data. Used when reading in a format record

Parameters:

t - the raw data

ws - the workbook settings

biffType - biff type dummy overload

Method Detail

getData

public byte[] getData()

Used to get the data when writing out the format record

Specified by:

getData in class WritableRecordData

Returns:

the raw data

getFormatIndex

public int getFormatIndex()

Gets the format index of this record

Specified by:

getFormatIndex in interface DisplayFormat

Returns:

the format index of this record

isInitialized

public boolean isInitialized()

Accessor to see whether this object is initialized or not.

Specified by:

isInitialized in interface DisplayFormat

Returns:

TRUE if this font record has been initialized, FALSE otherwise

initialize

public void initialize(int pos)

Sets the index of this record. Called from the FormattingRecords object

Specified by:

initialize in interface DisplayFormat

Parameters:

pos - the position of this font in the workbooks font list

replace

protected final java.lang.String replace(java.lang.String input,
                                         java.lang.String search,
                                         java.lang.String replace)

Replaces all instances of search with replace in the input. Used for replacing microsoft number formatting characters with java equivalents

Parameters:

input - the format string

search - the Excel character to be replaced

replace - the java equivalent

Returns:

the input string with the specified substring replaced

setFormatString

protected final void setFormatString(java.lang.String s)

Called by the immediate subclass to set the string once the Java-Excel replacements have been done

Parameters:

s - the format string

isDate

public final boolean isDate()

Sees if this format is a date format

Returns:

TRUE if this format is a date

isNumber

public final boolean isNumber()

Sees if this format is a number format

Returns:

TRUE if this format is a number

getNumberFormat

public final java.text.NumberFormat getNumberFormat()

Gets the java equivalent number format for the formatString

Returns:

The java equivalent of the number format for this object

getDateFormat

public final java.text.DateFormat getDateFormat()

Gets the java equivalent date format for the formatString

Returns:

The java equivalent of the date format for this object

getIndexCode

public int getIndexCode()

Gets the index code, for use as a hash value

Returns:

the ifmt code for this cell

getFormatString

public java.lang.String getFormatString()

Gets the formatting string.

Specified by:

getFormatString in interface Format

Returns:

the excel format string

isBuiltIn

public boolean isBuiltIn()

Indicates whether this formula is a built in

Specified by:

isBuiltIn in interface DisplayFormat

Returns:

FALSE

hashCode

public int hashCode()

Standard hash code method

Returns:

the hash code value for this object

equals

public boolean equals(java.lang.Object o)

Standard equals method. This compares the contents of two format records, and not their indexCodes, which are ignored

Parameters:

o - the object to compare

Returns:

TRUE if the two objects are equal, FALSE otherwise