org.apache.poi.hssf.record
Class NoteStructureSubRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.SubRecord
              extended by org.apache.poi.hssf.record.NoteStructureSubRecord

public class NoteStructureSubRecord
extends SubRecord

Represents a NoteStructure (0xD) sub record.

The docs say nothing about it. The length of this record is always 26 bytes.

Author:
Yegor Kozlov

Field Summary
static short sid
           
 
Constructor Summary
NoteStructureSubRecord()
          Construct a new NoteStructureSubRecord and fill its data with the default values
NoteStructureSubRecord(RecordInputStream in)
          Read the record data from the supplied RecordInputStream
 
Method Summary
 java.lang.Object clone()
           
 int getRecordSize()
          gives the current serialized size of the record.
 short getSid()
          return the non static version of the id for this record.
 int serialize(int offset, byte[] data)
          Serialize the record data into the supplied array of bytes
 java.lang.String toString()
          Convert this record to string.
 
Methods inherited from class org.apache.poi.hssf.record.SubRecord
createSubRecord
 
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values
Constructor Detail

NoteStructureSubRecord

public NoteStructureSubRecord()
Construct a new NoteStructureSubRecord and fill its data with the default values


NoteStructureSubRecord

public NoteStructureSubRecord(RecordInputStream in)
Read the record data from the supplied RecordInputStream

Method Detail

toString

public java.lang.String toString()
Convert this record to string. Used by BiffViewer and other utulities.

Overrides:
toString in class Record

serialize

public int serialize(int offset,
                     byte[] data)
Serialize the record data into the supplied array of bytes

Specified by:
serialize in class RecordBase
Parameters:
offset - offset in the data
data - the data to serialize into
Returns:
size of the record

getRecordSize

public int getRecordSize()
Description copied from class: Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Overrides:
getRecordSize in class Record

getSid

public short getSid()
Description copied from class: Record
return the non static version of the id for this record.

Specified by:
getSid in class Record
Returns:
id of this record.

clone

public java.lang.Object clone()
Overrides:
clone in class Record


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.