Package org.apache.poi.hssf.record
Class RefModeRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.RefModeRecord
Title: RefMode Record
Description: Describes which reference mode to use
REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final short
static final short
static final short
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
protected int
short
getMode()
get the reference mode to use (HSSF uses/assumes A1)short
getSid()
return the non static version of the id for this record.void
Write the data content of this BIFF record.void
setMode
(short mode) set the reference mode to use (HSSF uses/assumes A1)toString()
get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
USE_A1_MODE
public static final short USE_A1_MODE- See Also:
-
USE_R1C1_MODE
public static final short USE_R1C1_MODE- See Also:
-
-
Constructor Details
-
RefModeRecord
public RefModeRecord() -
RefModeRecord
-
-
Method Details
-
setMode
public void setMode(short mode) set the reference mode to use (HSSF uses/assumes A1)- Parameters:
mode
- the mode to use- See Also:
-
getMode
public short getMode()get the reference mode to use (HSSF uses/assumes A1)- Returns:
- mode to use
- See Also:
-
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
serialize
Description copied from class:StandardRecord
Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.The number of bytes written must equal the record size reported by
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
clone
-