Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class LeftMarginRecord

extends StandardRecord
implements Margin
Class Inheritance
All Implemented Interfaces
org.apache.poi.hssf.record.Margin
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Record for the left margin.

Field Summary

Modifier and TypeField and Description
private double
field_1_margin

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
LeftMarginRecord()

public
LeftMarginRecord(LeftMarginRecord other)

public
LeftMarginRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public LeftMarginRecord
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public double
getMargin()

Implements org.apache.poi.hssf.record.Margin.getMargin.

Get the margin field for the LeftMargin record.

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
setMargin(double
the margin
field_1_margin)

Implements org.apache.poi.hssf.record.Margin.setMargin.

Set the margin field for the LeftMargin record.

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

field_1_marginback to summary
private double field_1_margin
sidback to summary
public static final short sid

Constructor Detail

LeftMarginRecordback to summary
public LeftMarginRecord()
LeftMarginRecordback to summary
public LeftMarginRecord(LeftMarginRecord other)
LeftMarginRecordback to summary
public LeftMarginRecord(RecordInputStream in)

Method Detail

copyback to summary
public LeftMarginRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:LeftMarginRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getMarginback to summary
public double getMargin()

Implements org.apache.poi.hssf.record.Margin.getMargin.

Get the margin field for the LeftMargin record.

Returns:double

Doc from org.apache.poi.hssf.record.Margin.getMargin.

the margin

getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

setMarginback to summary
public void setMargin(double field_1_margin)

Implements org.apache.poi.hssf.record.Margin.setMargin.

Set the margin field for the LeftMargin record.

Parameters
field_1_margin:double

Doc from org.apache.poi.hssf.record.Margin.setMargin.

the margin