Class CommonObjectDataSubRecord

java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.SubRecord
loci.poi.hssf.record.CommonObjectDataSubRecord

public class CommonObjectDataSubRecord extends SubRecord
The common object data record is used to store all common preferences for an excel object. 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)
  • Field Details

  • Constructor Details

    • CommonObjectDataSubRecord

      public CommonObjectDataSubRecord()
    • CommonObjectDataSubRecord

      public CommonObjectDataSubRecord(RecordInputStream in)
      Constructs a CommonObjectData 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:
      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
    • clone

      public Object clone()
      Overrides:
      clone in class Record
    • getObjectType

      public short getObjectType()
      Get the object type field for the CommonObjectData record.
      Returns:
      One of OBJECT_TYPE_GROUP OBJECT_TYPE_LINE OBJECT_TYPE_RECTANGLE OBJECT_TYPE_OVAL OBJECT_TYPE_ARC OBJECT_TYPE_CHART OBJECT_TYPE_TEXT OBJECT_TYPE_BUTTON OBJECT_TYPE_PICTURE OBJECT_TYPE_POLYGON OBJECT_TYPE_RESERVED1 OBJECT_TYPE_CHECKBOX OBJECT_TYPE_OPTION_BUTTON OBJECT_TYPE_EDIT_BOX OBJECT_TYPE_LABEL OBJECT_TYPE_DIALOG_BOX OBJECT_TYPE_SPINNER OBJECT_TYPE_SCROLL_BAR OBJECT_TYPE_LIST_BOX OBJECT_TYPE_GROUP_BOX OBJECT_TYPE_COMBO_BOX OBJECT_TYPE_RESERVED2 OBJECT_TYPE_RESERVED3 OBJECT_TYPE_RESERVED4 OBJECT_TYPE_RESERVED5 OBJECT_TYPE_COMMENT OBJECT_TYPE_RESERVED6 OBJECT_TYPE_RESERVED7 OBJECT_TYPE_RESERVED8 OBJECT_TYPE_RESERVED9 OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING
    • setObjectType

      public void setObjectType(short field_1_objectType)
      Set the object type field for the CommonObjectData record.
      Parameters:
      field_1_objectType - One of OBJECT_TYPE_GROUP OBJECT_TYPE_LINE OBJECT_TYPE_RECTANGLE OBJECT_TYPE_OVAL OBJECT_TYPE_ARC OBJECT_TYPE_CHART OBJECT_TYPE_TEXT OBJECT_TYPE_BUTTON OBJECT_TYPE_PICTURE OBJECT_TYPE_POLYGON OBJECT_TYPE_RESERVED1 OBJECT_TYPE_CHECKBOX OBJECT_TYPE_OPTION_BUTTON OBJECT_TYPE_EDIT_BOX OBJECT_TYPE_LABEL OBJECT_TYPE_DIALOG_BOX OBJECT_TYPE_SPINNER OBJECT_TYPE_SCROLL_BAR OBJECT_TYPE_LIST_BOX OBJECT_TYPE_GROUP_BOX OBJECT_TYPE_COMBO_BOX OBJECT_TYPE_RESERVED2 OBJECT_TYPE_RESERVED3 OBJECT_TYPE_RESERVED4 OBJECT_TYPE_RESERVED5 OBJECT_TYPE_COMMENT OBJECT_TYPE_RESERVED6 OBJECT_TYPE_RESERVED7 OBJECT_TYPE_RESERVED8 OBJECT_TYPE_RESERVED9 OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING
    • getObjectId

      public short getObjectId()
      Get the object id field for the CommonObjectData record.
    • setObjectId

      public void setObjectId(short field_2_objectId)
      Set the object id field for the CommonObjectData record.
    • getOption

      public short getOption()
      Get the option field for the CommonObjectData record.
    • setOption

      public void setOption(short field_3_option)
      Set the option field for the CommonObjectData record.
    • getReserved1

      public int getReserved1()
      Get the reserved1 field for the CommonObjectData record.
    • setReserved1

      public void setReserved1(int field_4_reserved1)
      Set the reserved1 field for the CommonObjectData record.
    • getReserved2

      public int getReserved2()
      Get the reserved2 field for the CommonObjectData record.
    • setReserved2

      public void setReserved2(int field_5_reserved2)
      Set the reserved2 field for the CommonObjectData record.
    • getReserved3

      public int getReserved3()
      Get the reserved3 field for the CommonObjectData record.
    • setReserved3

      public void setReserved3(int field_6_reserved3)
      Set the reserved3 field for the CommonObjectData record.
    • setLocked

      public void setLocked(boolean value)
      Sets the locked field value. true if object is locked when sheet has been protected
    • isLocked

      public boolean isLocked()
      true if object is locked when sheet has been protected
      Returns:
      the locked field value.
    • setPrintable

      public void setPrintable(boolean value)
      Sets the printable field value. object appears when printed
    • isPrintable

      public boolean isPrintable()
      object appears when printed
      Returns:
      the printable field value.
    • setAutofill

      public void setAutofill(boolean value)
      Sets the autofill field value. whether object uses an automatic fill style
    • isAutofill

      public boolean isAutofill()
      whether object uses an automatic fill style
      Returns:
      the autofill field value.
    • setAutoline

      public void setAutoline(boolean value)
      Sets the autoline field value. whether object uses an automatic line style
    • isAutoline

      public boolean isAutoline()
      whether object uses an automatic line style
      Returns:
      the autoline field value.