Class BOFRecord

  • All Implemented Interfaces:
    java.lang.Cloneable

    public final class BOFRecord
    extends StandardRecord
    implements java.lang.Cloneable
    Title: Beginning Of File (0x0809)

    Description: Somewhat of a misnomer, its used for the beginning of a set of records that have a particular purpose or subject. Used in sheets and workbooks.

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

    • Constructor Detail

      • BOFRecord

        public BOFRecord()
        Constructs an empty BOFRecord with no fields set.
    • Method Detail

      • createSheetBOF

        public static BOFRecord createSheetBOF()
      • setVersion

        public void setVersion​(int version)
        Version number - for BIFF8 should be 0x06
        Parameters:
        version - version to be set
        See Also:
        VERSION
      • setBuild

        public void setBuild​(int build)
        build that wrote this file
        Parameters:
        build - build number to set
        See Also:
        BUILD
      • setBuildYear

        public void setBuildYear​(int year)
        Year of the build that wrote this file
        Parameters:
        year - build year to set
        See Also:
        BUILD_YEAR
      • setHistoryBitMask

        public void setHistoryBitMask​(int bitmask)
        set the history bit mask (not very useful)
        Parameters:
        bitmask - bitmask to set for the history
        See Also:
        HISTORY_MASK
      • setRequiredVersion

        public void setRequiredVersion​(int version)
        set the minimum version required to read this file
        Parameters:
        version - version to set
        See Also:
        VERSION
      • getVersion

        public int getVersion()
        Version number - for BIFF8 should be 0x06
        Returns:
        version number of the generator of this file
        See Also:
        VERSION
      • getBuild

        public int getBuild()
        get the build that wrote this file
        Returns:
        short build number of the generator of this file
        See Also:
        BUILD
      • getBuildYear

        public int getBuildYear()
        Year of the build that wrote this file
        Returns:
        short build year of the generator of this file
        See Also:
        BUILD_YEAR
      • getHistoryBitMask

        public int getHistoryBitMask()
        get the history bit mask (not very useful)
        Returns:
        int bitmask showing the history of the file (who cares!)
        See Also:
        HISTORY_MASK
      • getRequiredVersion

        public int getRequiredVersion()
        get the minimum version required to read this file
        Returns:
        int least version that can read the file
        See Also:
        VERSION
      • 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
      • 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