Package loci.poi.hssf.record

Class 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)

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.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.
      java.lang.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 java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • 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 class Record
        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 class Record
        Parameters:
        in - the RecordInputstream to read the record from

      • toString

        public java.lang.String toString()
        Description copied from class: Record
        get a string representation of the record (for biffview/debugging)
        Overrides:
        toString in class Record

      • 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.
        Specified by:
        serialize in class Record
        Parameters:
        offset - to begin writing at
        data - byte array containing instance data
        Returns:
        number of bytes written

      • getRecordSize

        public int getRecordSize()
        Size of record (exluding 4 byte header)
        Overrides:
        getRecordSize in class Record

      • getSid

        public short getSid()
        Description copied from class: Record
        return the non static version of the id for this record.
        Specified by:
        getSid in class Record

      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class 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.