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.TabIdRecord

public final class TabIdRecord
extends Record

Title: Sheet Tab Index Array Record

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)

Version:
2.0-pre
Author:
Andrew C. Oliver (acoliver at apache dot org)

Field Summary
 short[] field_1_tabids
           
static short sid
           
 
Constructor Summary
TabIdRecord()
           
TabIdRecord(RecordInputStream in)
           
 
Method Summary
 int getRecordSize()
          gives the current serialized size of the record.
 short getSid()
          return the non static version of the id for this record.
 short[] getTabIdArray()
          get the tab array.
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 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.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

field_1_tabids

public short[] field_1_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}

getTabIdArray

public short[] getTabIdArray()
get the tab array. (0,1,2).

Returns:
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 int serialize(int offset,
                     byte[] data)
Description copied from class: RecordBase
called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Specified by:
serialize in class RecordBase
Parameters:
offset - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

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


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