org.apache.poi.hssf.record

## Class PrintHeadersRecord

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

- All Implemented Interfaces:
    Duplicatable

      public final class PrintHeadersRecord
      extends StandardRecord

  Whether or not to print the row/column headers when you enjoy your spreadsheet in the physical form.
  Version:
    2.0-pre

- - ### Field Summary

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

  - ### Constructor Summary

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

  - ### Method Summary

    All Methods Instance Methods Concrete Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `PrintHeadersRecord` | `clone()` Deprecated.
    `PrintHeadersRecord` | `copy()`
    `protected int` | `getDataSize()`
    `boolean` | `getPrintHeaders()` get whether to print the headers - y/n
    `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` | `setPrintHeaders(boolean p)` set to print the headers - y/n
    `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

    - #### PrintHeadersRecord

          public PrintHeadersRecord()

    - #### PrintHeadersRecord

          public PrintHeadersRecord(PrintHeadersRecord other)

    - #### PrintHeadersRecord

          public PrintHeadersRecord(RecordInputStream in)

  - ### Method Detail

    - #### setPrintHeaders

          public void setPrintHeaders(boolean p)

      set to print the headers - y/n
      Parameters:
        `p` - printheaders or not

    - #### getPrintHeaders

          public boolean getPrintHeaders()

      get whether to print the headers - y/n
      Returns:
        printheaders or not

    - #### 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 PrintHeadersRecord clone()

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

    - #### copy

          public PrintHeadersRecord 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.