org.apache.poi.hssf.record

## Class DimensionsRecord

- 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.DimensionsRecord

- All Implemented Interfaces:
    Duplicatable

      public final class DimensionsRecord
      extends StandardRecord

  Provides the minumum and maximum bounds of a sheet.
  Version:
    2.0-pre

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static short` | `sid`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `DimensionsRecord()`
    `DimensionsRecord(DimensionsRecord other)`
    `DimensionsRecord(RecordInputStream in)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `DimensionsRecord` | `clone()` Deprecated.
    `DimensionsRecord` | `copy()`
    `protected int` | `getDataSize()`
    `short` | `getFirstCol()` get the first column number for the sheet
    `int` | `getFirstRow()` get the first row number for the sheet
    `short` | `getLastCol()` get the last col number for the sheet
    `int` | `getLastRow()` get the last row number for the sheet
    `short` | `getSid()` return the non static version of the id for this record.
    `void` | `serialize(LittleEndianOutput out)` Write the data content of this BIFF record.
    `void` | `setFirstCol(short col)` set the first column number for the sheet
    `void` | `setFirstRow(int row)` set the first row number for the sheet
    `void` | `setLastCol(short col)` set the last col number for the sheet
    `void` | `setLastRow(int row)` set the last row number for the sheet
    `java.lang.String` | `toString()` get a string representation of the record (for biffview/debugging)

    - ### Methods inherited from class org.apache.poi.hssf.record.StandardRecord

      `getRecordSize, serialize`

    - ### Methods inherited from class org.apache.poi.hssf.record.Record

      `cloneViaReserialise, serialize`

    - ### Methods inherited from class java.lang.Object

      `equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### sid

          public static final short sid

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### DimensionsRecord

          public DimensionsRecord()

    - #### DimensionsRecord

          public DimensionsRecord(DimensionsRecord other)

    - #### DimensionsRecord

          public DimensionsRecord(RecordInputStream in)

  - ### Method Detail

    - #### setFirstRow

          public void setFirstRow(int row)

      set the first row number for the sheet
      Parameters:
        `row` - - first row on the sheet

    - #### setLastRow

          public void setLastRow(int row)

      set the last row number for the sheet
      Parameters:
        `row` - - last row on the sheet

    - #### setFirstCol

          public void setFirstCol(short col)

      set the first column number for the sheet
      Parameters:
        `col` - first column on the sheet

    - #### setLastCol

          public void setLastCol(short col)

      set the last col number for the sheet
      Parameters:
        `col` - last column on the sheet

    - #### getFirstRow

          public int getFirstRow()

      get the first row number for the sheet
      Returns:
        row - first row on the sheet

    - #### getLastRow

          public int getLastRow()

      get the last row number for the sheet
      Returns:
        row - last row on the sheet

    - #### getFirstCol

          public short getFirstCol()

      get the first column number for the sheet
      Returns:
        column - first column on the sheet

    - #### getLastCol

          public short getLastCol()

      get the last col number for the sheet
      Returns:
        column - last column on the sheet

    - #### 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

    - #### 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

    - #### clone

          @Deprecated
           @Removal(version="5.0.0")
          public DimensionsRecord clone()

      Deprecated.
      Overrides:
        `clone` in class `java.lang.Object`

    - #### copy

          public DimensionsRecord copy()

      Specified by:
        `copy` in interface `Duplicatable`
      Specified by:
        `copy` in class `StandardRecord`
      Returns:
        a deep copy of the implementing class / instance

Copyright 2020 The Apache Software Foundation or its licensors, as applicable.