Package org.apache.poi.hssf.record
Class LabelRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.LabelRecord
- All Implemented Interfaces:
Cloneable,CellValueRecordInterface
Label Record (0x0204) - read only support for strings stored directly in the cell...
Don't use this (except to read), use LabelSST instead
REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()shortintgives the current serialized size of the record.intgetRow()shortgetSid()return the non static version of the id for this record.shortget the number of characters this string containsgetValue()get the valueshortbooleanis this uncompressed unicode (16bit)? Or just 8-bit compressed?intserialize(int offset, byte[] data) THROWS A RUNTIME EXCEPTION..voidsetColumn(short col) NO-OP!voidsetRow(int row) NO-OP!voidsetXFIndex(short xf) no op!toString()get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
LabelRecord
public LabelRecord()Creates new LabelRecord -
LabelRecord
- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
getRow
public int getRow()- Specified by:
getRowin interfaceCellValueRecordInterface- Returns:
- the row this cell occurs on
-
getColumn
public short getColumn()- Specified by:
getColumnin interfaceCellValueRecordInterface- Returns:
- the column this cell defines within the row
-
getXFIndex
public short getXFIndex()- Specified by:
getXFIndexin interfaceCellValueRecordInterface
-
getStringLength
public short getStringLength()get the number of characters this string contains- Returns:
- number of characters
-
isUnCompressedUnicode
public boolean isUnCompressedUnicode()is this uncompressed unicode (16bit)? Or just 8-bit compressed?- Returns:
- isUnicode - True for 16bit- false for 8bit
-
getValue
get the value- Returns:
- the text string
- See Also:
-
serialize
public int serialize(int offset, byte[] data) THROWS A RUNTIME EXCEPTION.. USE LABELSSTRecords. YOU HAVE NO REASON to use LABELRecord!!- Specified by:
serializein classRecordBase- Parameters:
offset- to begin writing atdata- byte array containing instance data- Returns:
- number of bytes written
-
getRecordSize
public int getRecordSize()Description copied from class:RecordBasegives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Specified by:
getRecordSizein classRecordBase- Returns:
- the record size
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
setColumn
public void setColumn(short col) NO-OP!- Specified by:
setColumnin interfaceCellValueRecordInterface- Parameters:
col- the column this cell defines
-
setRow
public void setRow(int row) NO-OP!- Specified by:
setRowin interfaceCellValueRecordInterface- Parameters:
row- the row this cell occurs within
-
setXFIndex
public void setXFIndex(short xf) no op!- Specified by:
setXFIndexin interfaceCellValueRecordInterface
-
clone
-