FileDocCategorySizeDatePackage
EscherSpgrRecord.javaAPI DocApache Poi 3.0.16913Mon Jan 01 12:39:40 GMT 2007org.apache.poi.ddf

EscherSpgrRecord

public class EscherSpgrRecord extends EscherRecord
The spgr record defines information about a shape group. Groups in escher are simply another form of shape that you can't physically see.
author
Glen Stampoultzis (glens at apache.org)

Fields Summary
public static final short
RECORD_ID
public static final String
RECORD_DESCRIPTION
private int
field_1_rectX1
private int
field_2_rectY1
private int
field_3_rectX2
private int
field_4_rectY2
Constructors Summary
Methods Summary
public intfillFields(byte[] data, int offset, org.apache.poi.ddf.EscherRecordFactory recordFactory)
This method deserializes the record from a byte array.

param
data The byte array containing the escher record information
param
offset The starting offset into data.
param
recordFactory May be null since this is not a container record.
return
The number of bytes read from the byte array.


                                                                         
             
    
        int bytesRemaining = readHeader( data, offset );
        int pos            = offset + 8;
        int size           = 0;
        field_1_rectX1 =  LittleEndian.getInt( data, pos + size );size+=4;
        field_2_rectY1 =  LittleEndian.getInt( data, pos + size );size+=4;
        field_3_rectX2 =  LittleEndian.getInt( data, pos + size );size+=4;
        field_4_rectY2 =  LittleEndian.getInt( data, pos + size );size+=4;
        bytesRemaining -= size;
        if (bytesRemaining != 0) throw new RecordFormatException("Expected no remaining bytes but got " + bytesRemaining);
//        remainingData  =  new byte[bytesRemaining];
//        System.arraycopy( data, pos + size, remainingData, 0, bytesRemaining );
        return 8 + size + bytesRemaining;
public shortgetRecordId()
The 16 bit identifier of this shape group record.

        return RECORD_ID;
public java.lang.StringgetRecordName()
The short name for this record

        return "Spgr";
public intgetRecordSize()
Returns the number of bytes that are required to serialize this record.

return
Number of bytes

        return 8 + 16;
public intgetRectX1()
The starting top-left coordinate of child records.

        return field_1_rectX1;
public intgetRectX2()
The starting bottom-right coordinate of child records.

        return field_3_rectX2;
public intgetRectY1()
The starting top-left coordinate of child records.

        return field_2_rectY1;
public intgetRectY2()
The starting bottom-right coordinate of child records.

        return field_4_rectY2;
public intserialize(int offset, byte[] data, org.apache.poi.ddf.EscherSerializationListener listener)
This method serializes this escher record into a byte array.

param
offset The offset into data to start writing the record data to.
param
data The byte array to serialize to.
param
listener A listener to retrieve start and end callbacks. Use a NullEscherSerailizationListener to ignore these events.
return
The number of bytes written.
see
NullEscherSerializationListener

        listener.beforeRecordSerialize( offset, getRecordId(), this );
        LittleEndian.putShort( data, offset, getOptions() );
        LittleEndian.putShort( data, offset + 2, getRecordId() );
        int remainingBytes = 16;
        LittleEndian.putInt( data, offset + 4, remainingBytes );
        LittleEndian.putInt( data, offset + 8, field_1_rectX1 );
        LittleEndian.putInt( data, offset + 12, field_2_rectY1 );
        LittleEndian.putInt( data, offset + 16, field_3_rectX2 );
        LittleEndian.putInt( data, offset + 20, field_4_rectY2 );
//        System.arraycopy( remainingData, 0, data, offset + 26, remainingData.length );
//        int pos = offset + 8 + 18 + remainingData.length;
        listener.afterRecordSerialize( offset + getRecordSize(), getRecordId(), offset + getRecordSize(), this );
        return 8 + 16;
public voidsetRectX1(int x1)
The starting top-left coordinate of child records.

        this.field_1_rectX1 = x1;
public voidsetRectX2(int x2)
The starting bottom-right coordinate of child records.

        this.field_3_rectX2 = x2;
public voidsetRectY1(int y1)
The starting top-left coordinate of child records.

        this.field_2_rectY1 = y1;
public voidsetRectY2(int field_4_rectY2)
The starting bottom-right coordinate of child records.

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

return
the string representation of this record.

        String nl = System.getProperty("line.separator");

//        String extraData;
//        ByteArrayOutputStream b = new ByteArrayOutputStream();
//        try
//        {
//            HexDump.dump(this.remainingData, 0, b, 0);
//            extraData = b.toString();
//        }
//        catch ( Exception e )
//        {
//            extraData = "error";
//        }
        return getClass().getName() + ":" + nl +
                "  RecordId: 0x" + HexDump.toHex(RECORD_ID) + nl +
                "  Options: 0x" + HexDump.toHex(getOptions()) + nl +
                "  RectX: " + field_1_rectX1 + nl +
                "  RectY: " + field_2_rectY1 + nl +
                "  RectWidth: " + field_3_rectX2 + nl +
                "  RectHeight: " + field_4_rectY2 + nl;