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

SCLRecord

public class SCLRecord extends Record
Specifies the window's zoom magnification. If this record isn't present then the windows zoom is 100%. see p384 Excel Dev Kit NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
author
Andrew C. Oliver (acoliver at apache.org)

Fields Summary
public static final short
sid
private short
field_1_numerator
private short
field_2_denominator
Constructors Summary
public SCLRecord()



     
    

    
public SCLRecord(RecordInputStream in)
Constructs a SCL record and sets its fields appropriately.

param
id id must be 0xa0 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()

        SCLRecord rec = new SCLRecord();
    
        rec.field_1_numerator = field_1_numerator;
        rec.field_2_denominator = field_2_denominator;
        return rec;
    
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_numerator              = in.readShort();
        field_2_denominator            = in.readShort();
    
public shortgetDenominator()
Get the denominator field for the SCL record.

        return field_2_denominator;
    
public shortgetNumerator()
Get the numerator field for the SCL record.

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

        return 4  + 2 + 2;
    
public shortgetSid()

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

        int pos = 0;

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

        LittleEndian.putShort(data, 4 + offset + pos, field_1_numerator);
        LittleEndian.putShort(data, 6 + offset + pos, field_2_denominator);

        return getRecordSize();
    
public voidsetDenominator(short field_2_denominator)
Set the denominator field for the SCL record.

        this.field_2_denominator = field_2_denominator;
    
public voidsetNumerator(short field_1_numerator)
Set the numerator field for the SCL record.

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

        StringBuffer buffer = new StringBuffer();

        buffer.append("[SCL]\n");
        buffer.append("    .numerator            = ")
            .append("0x").append(HexDump.toHex(  getNumerator ()))
            .append(" (").append( getNumerator() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .denominator          = ")
            .append("0x").append(HexDump.toHex(  getDenominator ()))
            .append(" (").append( getDenominator() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

        buffer.append("[/SCL]\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 SCL record");
        }