File	Doc	Category	Size	Date	Package
TopMarginRecord.java	API Doc	Apache Poi 3.0.1	3459	Mon Jan 01 12:39:40 GMT 2007	org.apache.poi.hssf.record

TopMarginRecord

• java.lang.Object
  • org.apache.poi.hssf.record.RecordBase
    • org.apache.poi.hssf.record.Record

Fields Summary
public static final short	sid
private double	field_1_margin

Constructors Summary
public TopMarginRecord()
public TopMarginRecord(RecordInputStream in) Constructs a TopMargin record and sets its fields appropriately. param id id must be 0x28 or an exception will be throw upon validation param size size the size of the data area of the record param data data of the record (should not contain sid/len) super( in );

Methods Summary
public java.lang.Object	clone() TopMarginRecord rec = new TopMarginRecord(); rec.field_1_margin = this.field_1_margin; return rec;
protected void	fillFields(org.apache.poi.hssf.record.RecordInputStream in) field_1_margin = in.readDouble();
public double	getMargin() Get the margin field for the TopMargin record. return field_1_margin;
public int	getRecordSize() Size of record (exluding 4 byte header) return 4 + 8;
public short	getSid() return sid;
public int	serialize(int offset, byte[] data) LittleEndian.putShort( data, 0 + offset, sid ); LittleEndian.putShort( data, 2 + offset, (short) ( getRecordSize() - 4 ) ); LittleEndian.putDouble( data, 4 + offset, field_1_margin ); return getRecordSize();
public void	setMargin(double field_1_margin) Set the margin field for the TopMargin record. this.field_1_margin = field_1_margin;
public java.lang.String	toString() StringBuffer buffer = new StringBuffer(); buffer.append( "[TopMargin]\n" ); buffer.append( " .margin = " ).append( " (" ).append( getMargin() ).append( " )\n" ); buffer.append( "[/TopMargin]\n" ); return buffer.toString();
protected void	validateSid(short id) Checks the sid matches the expected side for this record param id the expected sid. if ( id != sid ) { throw new RecordFormatException( "Not a TopMargin record" ); }