Package org.apache.poi.hssf.record

Class GutsRecord

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.GutsRecord
All Implemented Interfaces:
Duplicatable, GenericRecord
public final class GutsRecord extends StandardRecord
Row/column gutter sizes

  • Field Details

  • Constructor Details

    • GutsRecord

      public GutsRecord()

    • GutsRecord

      public GutsRecord(GutsRecord other)

    • GutsRecord

      public GutsRecord(RecordInputStream in)

  • Method Details

    • setLeftRowGutter

      public void setLeftRowGutter(short gut)
      set the size of the gutter that appears at the left of the rows
      Parameters:
      gut - gutter size in screen units

    • setTopColGutter

      public void setTopColGutter(short gut)
      set the size of the gutter that appears at the above the columns
      Parameters:
      gut - gutter size in screen units

    • setRowLevelMax

      public void setRowLevelMax(short max)
      set the maximum outline level for the row gutter.
      Parameters:
      max - maximum outline level

    • setColLevelMax

      public void setColLevelMax(short max)
      set the maximum outline level for the col gutter.
      Parameters:
      max - maximum outline level

    • getLeftRowGutter

      public short getLeftRowGutter()
      get the size of the gutter that appears at the left of the rows
      Returns:
      gutter size in screen units

    • getTopColGutter

      public short getTopColGutter()
      get the size of the gutter that appears at the above the columns
      Returns:
      gutter size in screen units

    • getRowLevelMax

      public short getRowLevelMax()
      get the maximum outline level for the row gutter.
      Returns:
      maximum outline level

    • getColLevelMax

      public short getColLevelMax()
      get the maximum outline level for the col gutter.
      Returns:
      maximum outline level

    • 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

    • getDataSize

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

    • 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

    • copy

      public GutsRecord 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()