Class FrameRecord


  • public class FrameRecord
    extends Record
    The frame record indicates whether there is a border around the displayed text of a chart. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
    Author:
    Glen Stampoultzis (glens at apache.org)
    • Constructor Detail

      • FrameRecord

        public FrameRecord()
      • FrameRecord

        public FrameRecord​(RecordInputStream in)
        Constructs a Frame 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 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
      • getBorderType

        public short getBorderType()
        Get the border type field for the Frame record.
        Returns:
        One of BORDER_TYPE_REGULAR BORDER_TYPE_SHADOW
      • setBorderType

        public void setBorderType​(short field_1_borderType)
        Set the border type field for the Frame record.
        Parameters:
        field_1_borderType - One of BORDER_TYPE_REGULAR BORDER_TYPE_SHADOW
      • getOptions

        public short getOptions()
        Get the options field for the Frame record.
      • setOptions

        public void setOptions​(short field_2_options)
        Set the options field for the Frame record.
      • setAutoSize

        public void setAutoSize​(boolean value)
        Sets the auto size field value. excel calculates the size automatically if true
      • isAutoSize

        public boolean isAutoSize()
        excel calculates the size automatically if true
        Returns:
        the auto size field value.
      • setAutoPosition

        public void setAutoPosition​(boolean value)
        Sets the auto position field value. excel calculates the position automatically
      • isAutoPosition

        public boolean isAutoPosition()
        excel calculates the position automatically
        Returns:
        the auto position field value.