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

AxisUsedRecord

public class AxisUsedRecord extends Record
The number of axes used on a chart. 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 short
field_1_numAxis
Constructors Summary
public AxisUsedRecord()



     
    

    
public AxisUsedRecord(RecordInputStream in)
Constructs a AxisUsed record and sets its fields appropriately.

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

        AxisUsedRecord rec = new AxisUsedRecord();
    
        rec.field_1_numAxis = field_1_numAxis;
        return rec;
    
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_numAxis                = in.readShort();
    
public shortgetNumAxis()
Get the num axis field for the AxisUsed record.

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

        return 4  + 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_numAxis);

        return getRecordSize();
    
public voidsetNumAxis(short field_1_numAxis)
Set the num axis field for the AxisUsed record.

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

        StringBuffer buffer = new StringBuffer();

        buffer.append("[AXISUSED]\n");
        buffer.append("    .numAxis              = ")
            .append("0x").append(HexDump.toHex(  getNumAxis ()))
            .append(" (").append( getNumAxis() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

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