Package loci.poi.hssf.record
Class ObjectLinkRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.ObjectLinkRecord
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)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final short -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a ObjectLink record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortGet the anchor id field for the ObjectLink record.shortgetLink1()Get the link 1 field for the ObjectLink record.shortgetLink2()Get the link 2 field for the ObjectLink record.intSize of record (exluding 4 byte header)shortgetSid()return the non static version of the id for this record.intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetAnchorId(short field_1_anchorId) Set the anchor id field for the ObjectLink record.voidsetLink1(short field_2_link1) Set the link 1 field for the ObjectLink record.voidsetLink2(short field_3_link2) Set the link 2 field for the ObjectLink record.toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) Checks the sid matches the expected side for this recordMethods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
ANCHOR_ID_CHART_TITLE
public static final short ANCHOR_ID_CHART_TITLE- See Also:
-
ANCHOR_ID_Y_AXIS
public static final short ANCHOR_ID_Y_AXIS- See Also:
-
ANCHOR_ID_X_AXIS
public static final short ANCHOR_ID_X_AXIS- See Also:
-
ANCHOR_ID_SERIES_OR_POINT
public static final short ANCHOR_ID_SERIES_OR_POINT- See Also:
-
ANCHOR_ID_Z_AXIS
public static final short ANCHOR_ID_Z_AXIS- See Also:
-
-
Constructor Details
-
ObjectLinkRecord
public ObjectLinkRecord() -
ObjectLinkRecord
Constructs a ObjectLink record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Checks the sid matches the expected side for this record- Specified by:
validateSidin classRecord- Parameters:
id- the expected sid.
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array. -
getRecordSize
public int getRecordSize()Size of record (exluding 4 byte header)- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-
getAnchorId
public short getAnchorId()Get the anchor id field for the ObjectLink record.- Returns:
- One of ANCHOR_ID_CHART_TITLE ANCHOR_ID_Y_AXIS ANCHOR_ID_X_AXIS ANCHOR_ID_SERIES_OR_POINT ANCHOR_ID_Z_AXIS
-
setAnchorId
public void setAnchorId(short field_1_anchorId) Set the anchor id field for the ObjectLink record.- Parameters:
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
-
getLink1
public short getLink1()Get the link 1 field for the ObjectLink record. -
setLink1
public void setLink1(short field_2_link1) Set the link 1 field for the ObjectLink record. -
getLink2
public short getLink2()Get the link 2 field for the ObjectLink record. -
setLink2
public void setLink2(short field_3_link2) Set the link 2 field for the ObjectLink record.
-