Package org.apache.poi.hssf.record

Class SupBookRecord

  • public final class SupBookRecord
extends StandardRecord
    Title: Sup Book - EXTERNALBOOK (0x01AE)

    Description: A External Workbook Description (Supplemental Book) Its only a dummy record for making new ExternSheet Record

    REFERENCE: 5.38

    • Constructor Detail

      • SupBookRecord

        public SupBookRecord​(java.lang.String url,
                     java.lang.String[] sheetNames)

      • SupBookRecord

        public SupBookRecord​(RecordInputStream in)
        called by the constructor, should set class level fields. Should throw runtime exception for bad/incomplete data.
        Parameters:
        in - the stream to read from

    • Method Detail

      • createInternalReferences

        public static SupBookRecord createInternalReferences​(short numberOfSheets)

      • createAddInFunctions

        public static SupBookRecord createAddInFunctions()

      • createExternalReferences

        public static SupBookRecord createExternalReferences​(java.lang.String url,
                                                     java.lang.String[] sheetNames)

      • isExternalReferences

        public boolean isExternalReferences()

      • isInternalReferences

        public boolean isInternalReferences()

      • isAddInFunctions

        public boolean isAddInFunctions()

      • 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

      • setNumberOfSheets

        public void setNumberOfSheets​(short number)

      • getNumberOfSheets

        public short getNumberOfSheets()

      • 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

      • getURL

        public java.lang.String getURL()

      • getSheetNames

        public java.lang.String[] getSheetNames()

      • setURL

        public void setURL​(java.lang.String pUrl)