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

ObjectLinkRecord

public class ObjectLinkRecord extends Record
Links text to an object on the chart or identifies it as the title. 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_anchorId
public static final short
ANCHOR_ID_CHART_TITLE
public static final short
ANCHOR_ID_Y_AXIS
public static final short
ANCHOR_ID_X_AXIS
public static final short
ANCHOR_ID_SERIES_OR_POINT
public static final short
ANCHOR_ID_Z_AXIS
private short
field_2_link1
private short
field_3_link2
Constructors Summary
public ObjectLinkRecord()



     
    

    
public ObjectLinkRecord(RecordInputStream in)
Constructs a ObjectLink record and sets its fields appropriately.

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

        ObjectLinkRecord rec = new ObjectLinkRecord();
    
        rec.field_1_anchorId = field_1_anchorId;
        rec.field_2_link1 = field_2_link1;
        rec.field_3_link2 = field_3_link2;
        return rec;
    
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_anchorId               = in.readShort();
        field_2_link1                  = in.readShort();
        field_3_link2                  = in.readShort();

    
public shortgetAnchorId()
Get the anchor id field for the ObjectLink record.

return
One of ANCHOR_ID_CHART_TITLE ANCHOR_ID_Y_AXIS ANCHOR_ID_X_AXIS ANCHOR_ID_SERIES_OR_POINT ANCHOR_ID_Z_AXIS

        return field_1_anchorId;
    
public shortgetLink1()
Get the link 1 field for the ObjectLink record.

        return field_2_link1;
    
public shortgetLink2()
Get the link 2 field for the ObjectLink record.

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

        return 4  + 2 + 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_anchorId);
        LittleEndian.putShort(data, 6 + offset + pos, field_2_link1);
        LittleEndian.putShort(data, 8 + offset + pos, field_3_link2);

        return getRecordSize();
    
public voidsetAnchorId(short field_1_anchorId)
Set the anchor id field for the ObjectLink record.

param
field_1_anchorId One of ANCHOR_ID_CHART_TITLE ANCHOR_ID_Y_AXIS ANCHOR_ID_X_AXIS ANCHOR_ID_SERIES_OR_POINT ANCHOR_ID_Z_AXIS

        this.field_1_anchorId = field_1_anchorId;
    
public voidsetLink1(short field_2_link1)
Set the link 1 field for the ObjectLink record.

        this.field_2_link1 = field_2_link1;
    
public voidsetLink2(short field_3_link2)
Set the link 2 field for the ObjectLink record.

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

        StringBuffer buffer = new StringBuffer();

        buffer.append("[OBJECTLINK]\n");
        buffer.append("    .anchorId             = ")
            .append("0x").append(HexDump.toHex(  getAnchorId ()))
            .append(" (").append( getAnchorId() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .link1                = ")
            .append("0x").append(HexDump.toHex(  getLink1 ()))
            .append(" (").append( getLink1() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .link2                = ")
            .append("0x").append(HexDump.toHex(  getLink2 ()))
            .append(" (").append( getLink2() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

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