Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.hssf.record
Class TopMarginRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.StandardRecord
              extended by org.apache.poi.hssf.record.TopMarginRecord
All Implemented Interfaces:
Margin
public final class TopMarginRecord
extends StandardRecord
implements Margin

Record for the top margin.

Field Summary
static short sid
           
 
Constructor Summary
TopMarginRecord()
           
TopMarginRecord(RecordInputStream in)
           
 
Method Summary
 java.lang.Object clone()
           
protected  int getDataSize()
           
 double getMargin()
          Get the margin field for the TopMargin 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 TopMargin 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

TopMarginRecord

public TopMarginRecord()

TopMarginRecord

public TopMarginRecord(RecordInputStream in)
Parameters:
in - the RecordInputstream to read the record from
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 TopMargin record.

Specified by:
getMargin in interface Margin
Returns:
the margin

setMargin

public void setMargin(double field_1_margin)
Set the margin field for the TopMargin record.

Specified by:
setMargin in interface Margin
Parameters:
field_1_margin - the margin

clone

public java.lang.Object clone()
Overrides:
clone in class Record
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD