Package loci.poi.hssf.record
Class ObjectLinkRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.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)
-
-
Field Summary
Fields Modifier and Type Field Description static short
ANCHOR_ID_CHART_TITLE
static short
ANCHOR_ID_SERIES_OR_POINT
static short
ANCHOR_ID_X_AXIS
static short
ANCHOR_ID_Y_AXIS
static short
ANCHOR_ID_Z_AXIS
static short
sid
-
Constructor Summary
Constructors Constructor Description ObjectLinkRecord()
ObjectLinkRecord(RecordInputStream in)
Constructs a ObjectLink record and sets its fields appropriately.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
clone()
protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.short
getAnchorId()
Get the anchor id field for the ObjectLink record.short
getLink1()
Get the link 1 field for the ObjectLink record.short
getLink2()
Get the link 2 field for the ObjectLink record.int
getRecordSize()
Size of record (exluding 4 byte header)short
getSid()
return the non static version of the id for this record.int
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.void
setAnchorId(short field_1_anchorId)
Set the anchor id field for the ObjectLink record.void
setLink1(short field_2_link1)
Set the link 1 field for the ObjectLink record.void
setLink2(short field_3_link2)
Set the link 2 field for the ObjectLink record.String
toString()
get a string representation of the record (for biffview/debugging)protected void
validateSid(short id)
Checks the sid matches the expected side for this record-
Methods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
ANCHOR_ID_CHART_TITLE
public static final short ANCHOR_ID_CHART_TITLE
- See Also:
- Constant Field Values
-
ANCHOR_ID_Y_AXIS
public static final short ANCHOR_ID_Y_AXIS
- See Also:
- Constant Field Values
-
ANCHOR_ID_X_AXIS
public static final short ANCHOR_ID_X_AXIS
- See Also:
- Constant Field Values
-
ANCHOR_ID_SERIES_OR_POINT
public static final short ANCHOR_ID_SERIES_OR_POINT
- See Also:
- Constant Field Values
-
ANCHOR_ID_Z_AXIS
public static final short ANCHOR_ID_Z_AXIS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ObjectLinkRecord
public ObjectLinkRecord()
-
ObjectLinkRecord
public ObjectLinkRecord(RecordInputStream in)
Constructs a ObjectLink record and sets its fields appropriately.- Parameters:
in
- the RecordInputstream to read the record from
-
-
Method Detail
-
validateSid
protected void validateSid(short id)
Checks the sid matches the expected side for this record- Specified by:
validateSid
in classRecord
- Parameters:
id
- the expected sid.
-
fillFields
protected void fillFields(RecordInputStream in)
Description copied from class:Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFields
in classRecord
- Parameters:
in
- the RecordInputstream to read the record from
-
toString
public String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
serialize
public int serialize(int offset, byte[] data)
Description copied from class:Record
called 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:
getRecordSize
in classRecord
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
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.
-
-