FileDocCategorySizeDatePackage
PlotGrowthRecord.javaAPI DocApache Poi 3.0.14829Mon Jan 01 12:39:40 GMT 2007org.apache.poi.hssf.record

PlotGrowthRecord

public class PlotGrowthRecord extends Record
The plot growth record specifies the scaling factors used when a font is scaled. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
author
Glen Stampoultzis (glens at apache.org)

Fields Summary
public static final short
sid
private int
field_1_horizontalScale
private int
field_2_verticalScale
Constructors Summary
public PlotGrowthRecord()



     
    

    
public PlotGrowthRecord(RecordInputStream in)
Constructs a PlotGrowth record and sets its fields appropriately.

param
id id must be 0x1064 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.Objectclone()

        PlotGrowthRecord rec = new PlotGrowthRecord();
    
        rec.field_1_horizontalScale = field_1_horizontalScale;
        rec.field_2_verticalScale = field_2_verticalScale;
        return rec;
    
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_horizontalScale        = in.readInt();
        field_2_verticalScale          = in.readInt();

    
public intgetHorizontalScale()
Get the horizontalScale field for the PlotGrowth record.

        return field_1_horizontalScale;
    
public intgetRecordSize()
Size of record (exluding 4 byte header)

        return 4  + 4 + 4;
    
public shortgetSid()

        return sid;
    
public intgetVerticalScale()
Get the verticalScale field for the PlotGrowth record.

        return field_2_verticalScale;
    
public intserialize(int offset, byte[] data)

        int pos = 0;

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));

        LittleEndian.putInt(data, 4 + offset + pos, field_1_horizontalScale);
        LittleEndian.putInt(data, 8 + offset + pos, field_2_verticalScale);

        return getRecordSize();
    
public voidsetHorizontalScale(int field_1_horizontalScale)
Set the horizontalScale field for the PlotGrowth record.

        this.field_1_horizontalScale = field_1_horizontalScale;
    
public voidsetVerticalScale(int field_2_verticalScale)
Set the verticalScale field for the PlotGrowth record.

        this.field_2_verticalScale = field_2_verticalScale;
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[PLOTGROWTH]\n");
        buffer.append("    .horizontalScale      = ")
            .append("0x").append(HexDump.toHex(  getHorizontalScale ()))
            .append(" (").append( getHorizontalScale() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .verticalScale        = ")
            .append("0x").append(HexDump.toHex(  getVerticalScale ()))
            .append(" (").append( getVerticalScale() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

        buffer.append("[/PLOTGROWTH]\n");
        return buffer.toString();
    
protected voidvalidateSid(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 PlotGrowth record");
        }