org.apache.poi.hssf.record

## Class RightMarginRecord

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

- All Implemented Interfaces:
    Duplicatable, Margin

      public final class RightMarginRecord
      extends StandardRecord
      implements Margin

  Record for the right margin.

- - ### Field Summary

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

  - ### Constructor Summary

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

  - ### Method Summary

    All Methods Instance Methods Concrete Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `RightMarginRecord` | `clone()` Deprecated.
    `RightMarginRecord` | `copy()`
    `protected int` | `getDataSize()`
    `double` | `getMargin()` Get the margin field for the RightMargin record.
    `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` | `setMargin(double field_1_margin)` Set the margin field for the RightMargin record.
    `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

    - #### RightMarginRecord

          public RightMarginRecord()

    - #### RightMarginRecord

          public RightMarginRecord(RightMarginRecord other)

    - #### RightMarginRecord

          public RightMarginRecord(RecordInputStream in)

  - ### Method Detail

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

    - #### getMargin

          public double getMargin()

      Get the margin field for the RightMargin record.
      Specified by:
        `getMargin` in interface `Margin`
      Returns:
        the margin

    - #### setMargin

          public void setMargin(double field_1_margin)

      Set the margin field for the RightMargin record.
      Specified by:
        `setMargin` in interface `Margin`
      Parameters:
        `field_1_margin` - the margin

    - #### clone

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

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

    - #### copy

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