Class TabIdRecord


  • public 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 Detail

      • field_1_tabids

        public short[] field_1_tabids
    • Constructor Detail

      • TabIdRecord

        public TabIdRecord()
      • TabIdRecord

        public TabIdRecord​(RecordInputStream in)
        Constructs a TabID record and sets its fields appropriately.
        Parameters:
        in - the RecordInputstream to read the record from
    • Method Detail

      • validateSid

        protected void validateSid​(short id)
        Description copied from class: Record
        called by constructor, should throw runtime exception in the event of a record passed with a differing ID.
        Specified by:
        validateSid in class Record
        Parameters:
        id - alleged id for this record
      • fillFields

        protected void fillFields​(RecordInputStream in)
        Description copied from class: Record
        called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.
        Specified by:
        fillFields in class Record
        Parameters:
        in - the RecordInputstream to read the record from
      • 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 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: Record
        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 Record
        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