Package org.apache.poi.hssf.record

Class RefModeRecord

  • public final class RefModeRecord
extends StandardRecord
    Title: RefMode Record

    Description: Describes which reference mode to use

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

      • RefModeRecord

        public RefModeRecord()

    • Method Detail

      • setMode

        public void setMode​(short mode)
        set the reference mode to use (HSSF uses/assumes A1)
        Parameters:
        mode - the mode to use
        See Also:
        USE_A1_MODE, USE_R1C1_MODE

      • getMode

        public short getMode()
        get the reference mode to use (HSSF uses/assumes A1)
        Returns:
        mode to use
        See Also:
        USE_A1_MODE, USE_R1C1_MODE

      • 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

      • serialize

        public void serialize​(LittleEndianOutput out)
        Description copied from class: StandardRecord
        Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

        The number of bytes written must equal the record size reported by RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

        Specified by:
        serialize in class StandardRecord
        Parameters:
        out - the output object

      • 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

      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class Record