org.apache.poi.hssf.record
Class TabIdRecord

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.StandardRecord
              extended by org.apache.poi.hssf.record.TabIdRecord

public final class TabIdRecord
extends StandardRecord

Title: Sheet Tab Index Array Record (0x013D)

Description: Contains an array of sheet id's. Sheets always keep their ID regardless of what their name is.

REFERENCE: PG 412 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)


Field Summary
 short[] _tabids
           
static short sid
           
 
Constructor Summary
TabIdRecord()
           
TabIdRecord(RecordInputStream in)
           
 
Method Summary
protected  int getDataSize()
           
 short getSid()
          return the non static version of the id for this record.
 void serialize(LittleEndianOutput out)
          Write the data content of this BIFF record.
 void setTabIdArray(short[] array)
          set the tab array.
 java.lang.String 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
clone, 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

_tabids

public short[] _tabids
Constructor Detail

TabIdRecord

public TabIdRecord()

TabIdRecord

public TabIdRecord(RecordInputStream in)
Method Detail

setTabIdArray

public void setTabIdArray(short[] array)
set the tab array. (0,1,2).

Parameters:
array - of tab id's {0,1,2}

toString

public java.lang.String toString()
Description copied from class: Record
get a string representation of the record (for biffview/debugging)

Overrides:
toString in class Record

serialize

public void serialize(LittleEndianOutput out)
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 class StandardRecord
Parameters:
out - the output object

getDataSize

protected int getDataSize()
Specified by:
getDataSize in class StandardRecord

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:
he id for this record