Class CodepageRecord


  • public class CodepageRecord
    extends Record
    Title: Codepage Record

    Description: the default characterset. for the workbook

    REFERENCE: PG 293 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

      • CODEPAGE

        public static final short CODEPAGE
        the likely correct value for CODEPAGE (at least for US versions). We could use some help with international versions (which we do not have access to documentation for)
        See Also:
        Constant Field Values
    • Constructor Detail

      • CodepageRecord

        public CodepageRecord()
      • CodepageRecord

        public CodepageRecord​(RecordInputStream in)
        Constructs a CodepageRecord 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
      • setCodepage

        public void setCodepage​(short cp)
        set the codepage for this workbook
        Parameters:
        cp - the codepage to set
        See Also:
        CODEPAGE
      • getCodepage

        public short getCodepage()
        get the codepage for this workbook
        Returns:
        codepage - the codepage to set
        See Also:
        CODEPAGE
      • 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