Package org.apache.poi.hssf.record

Class BoundSheetRecord

java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.BoundSheetRecord
All Implemented Interfaces:
Duplicatable, GenericRecord
public final class BoundSheetRecord extends StandardRecord
Defines a sheet within a workbook. Basically stores the sheet name and tells where the Beginning of file record is within the HSSF file.

  • Field Details

  • Constructor Details

    • BoundSheetRecord

      public BoundSheetRecord(String sheetname)

    • BoundSheetRecord

      public BoundSheetRecord(BoundSheetRecord other)

    • BoundSheetRecord

      public BoundSheetRecord(RecordInputStream in)
      UTF8: sid + len + bof + flags + len(str) + unicode + str 2 + 2 + 4 + 2 + 1 + 1 + len(str) UNICODE: sid + len + bof + flags + len(str) + unicode + str 2 + 2 + 4 + 2 + 1 + 1 + 2 * len(str)
      Parameters:
      in - the record stream to read from

  • Method Details

    • setPositionOfBof

      public void setPositionOfBof(int pos)
      set the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
      Parameters:
      pos - offset in bytes

    • setSheetname

      public void setSheetname(String sheetName)
      Set the sheetname for this sheet. (this appears in the tabs at the bottom)
      Parameters:
      sheetName - the name of the sheet
      Throws:
      IllegalArgumentException - if sheet name will cause excel to crash.
      See Also:

    • getPositionOfBof

      public int getPositionOfBof()
      get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
      Returns:
      offset in bytes

    • getSheetname

      public String getSheetname()
      get the sheetname for this sheet. (this appears in the tabs at the bottom)
      Returns:
      sheetname the name of the sheet

    • getDataSize

      protected int getDataSize()
      Specified by:
      getDataSize in class StandardRecord

    • 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

    • isHidden

      public boolean isHidden()
      Is the sheet hidden? Different from very hidden
      Returns:
      true if hidden

    • setHidden

      public void setHidden(boolean hidden)
      Is the sheet hidden? Different from very hidden
      Parameters:
      hidden - true if hidden

    • isVeryHidden

      public boolean isVeryHidden()
      Is the sheet very hidden? Different from (normal) hidden
      Returns:
      true if very hidden

    • setVeryHidden

      public void setVeryHidden(boolean veryHidden)
      Is the sheet very hidden? Different from (normal) hidden
      Parameters:
      veryHidden - true if very hidden

    • orderByBofPosition

      public static BoundSheetRecord[] orderByBofPosition(List<BoundSheetRecord> boundSheetRecords)
      Converts a List of BoundSheetRecords to an array and sorts by the position of their BOFs.
      Parameters:
      boundSheetRecords - the boundSheetRecord list to arrayify
      Returns:
      the sorted boundSheetRecords

    • copy

      public BoundSheetRecord copy()
      Specified by:
      copy in interface Duplicatable
      Specified by:
      copy in class StandardRecord
      Returns:
      a deep copy of the implementing class / instance

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

      public Map<String,Supplier<?>> getGenericProperties()