Class LabelRecord

  • All Implemented Interfaces:
    CellValueRecordInterface

    public class LabelRecord
    extends Record
    implements CellValueRecordInterface
    Label Record - read only support for strings stored directly in the cell.. Don't use this (except to read), use LabelSST instead

    REFERENCE: PG 325 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)
    See Also:
    LabelSSTRecord
    • Constructor Detail

      • LabelRecord

        public LabelRecord()
        Creates new LabelRecord
      • LabelRecord

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

      • validateSid

        protected void validateSid​(short id)
        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
      • getStringLength

        public short getStringLength()
        get the number of characters this string contains
        Returns:
        number of characters
      • isUnCompressedUnicode

        public boolean isUnCompressedUnicode()
        is this uncompressed unicode (16bit)? Or just 8-bit compressed?
        Returns:
        isUnicode - True for 16bit- false for 8bit
      • serialize

        public int serialize​(int offset,
                             byte[] data)
        THROWS A RUNTIME EXCEPTION.. USE LABELSSTRecords. YOU HAVE NO REASON to use LABELRecord!!
        Specified by:
        serialize in class Record
        Parameters:
        offset - to begin writing at
        data - byte array containing instance data
        Returns:
        number of bytes written
      • 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
      • toString

        public String toString()
        Description copied from class: Record
        get a string representation of the record (for biffview/debugging)
        Overrides:
        toString in class Record
      • isInValueSection

        public boolean isInValueSection()
        Description copied from class: Record
        DBCELL, ROW, VALUES all say yes
        Overrides:
        isInValueSection in class Record
      • isValue

        public boolean isValue()
        Description copied from class: Record
        tells whether this type of record contains a value
        Overrides:
        isValue in class Record
      • setColumn

        public void setColumn​(short col)
        NO-OP!
        Specified by:
        setColumn in interface CellValueRecordInterface
        Parameters:
        col - the column this cell defines
      • setRow

        public void setRow​(int row)
        NO-OP!
        Specified by:
        setRow in interface CellValueRecordInterface
        Parameters:
        row - the row this cell occurs within