Class GutsRecord


  • public class GutsRecord
    extends Record
    Title: Guts Record

    Description: Row/column gutter sizes

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

    Version:
    2.0-pre
    Author:
    Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)
    • Constructor Detail

      • GutsRecord

        public GutsRecord()
      • GutsRecord

        public GutsRecord​(RecordInputStream in)
        Constructs a Guts 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
      • setLeftRowGutter

        public void setLeftRowGutter​(short gut)
        set the size of the gutter that appears at the left of the rows
        Parameters:
        gut - gutter size in screen units
      • setTopColGutter

        public void setTopColGutter​(short gut)
        set the size of the gutter that appears at the above the columns
        Parameters:
        gut - gutter size in screen units
      • setRowLevelMax

        public void setRowLevelMax​(short max)
        set the maximum outline level for the row gutter.
        Parameters:
        max - maximum outline level
      • setColLevelMax

        public void setColLevelMax​(short max)
        set the maximum outline level for the col gutter.
        Parameters:
        max - maximum outline level
      • getLeftRowGutter

        public short getLeftRowGutter()
        get the size of the gutter that appears at the left of the rows
        Returns:
        gutter size in screen units
      • getTopColGutter

        public short getTopColGutter()
        get the size of the gutter that appears at the above the columns
        Returns:
        gutter size in screen units
      • getRowLevelMax

        public short getRowLevelMax()
        get the maximum outline level for the row gutter.
        Returns:
        maximum outline level
      • getColLevelMax

        public short getColLevelMax()
        get the maximum outline level for the col gutter.
        Returns:
        maximum outline level
      • 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