CommonObjectDataSubRecord (POI API Documentation)

java.lang.Object
- org.apache.poi.hssf.record.SubRecord
- - org.apache.poi.hssf.record.CommonObjectDataSubRecord

All Implemented Interfaces:

Duplicatable, GenericRecord
```
public final class CommonObjectDataSubRecord
extends SubRecord
```
The common object data record is used to store all common preferences for an excel object.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.poi.hssf.record.SubRecord
  SubRecord.SubRecordTypes

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`OBJECT_TYPE_ARC`
`static short`	`OBJECT_TYPE_BUTTON`
`static short`	`OBJECT_TYPE_CHART`
`static short`	`OBJECT_TYPE_CHECKBOX`
`static short`	`OBJECT_TYPE_COMBO_BOX`
`static short`	`OBJECT_TYPE_COMMENT`
`static short`	`OBJECT_TYPE_DIALOG_BOX`
`static short`	`OBJECT_TYPE_EDIT_BOX`
`static short`	`OBJECT_TYPE_GROUP`
`static short`	`OBJECT_TYPE_GROUP_BOX`
`static short`	`OBJECT_TYPE_LABEL`
`static short`	`OBJECT_TYPE_LINE`
`static short`	`OBJECT_TYPE_LIST_BOX`
`static short`	`OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING`
`static short`	`OBJECT_TYPE_OPTION_BUTTON`
`static short`	`OBJECT_TYPE_OVAL`
`static short`	`OBJECT_TYPE_PICTURE`
`static short`	`OBJECT_TYPE_POLYGON`
`static short`	`OBJECT_TYPE_RECTANGLE`
`static short`	`OBJECT_TYPE_RESERVED1`
`static short`	`OBJECT_TYPE_RESERVED2`
`static short`	`OBJECT_TYPE_RESERVED3`
`static short`	`OBJECT_TYPE_RESERVED4`
`static short`	`OBJECT_TYPE_RESERVED5`
`static short`	`OBJECT_TYPE_RESERVED6`
`static short`	`OBJECT_TYPE_RESERVED7`
`static short`	`OBJECT_TYPE_RESERVED8`
`static short`	`OBJECT_TYPE_RESERVED9`
`static short`	`OBJECT_TYPE_SCROLL_BAR`
`static short`	`OBJECT_TYPE_SPINNER`
`static short`	`OBJECT_TYPE_TEXT`
`static short`	`sid`

Constructor Summary

Constructors
Constructor and Description
`CommonObjectDataSubRecord()`
`CommonObjectDataSubRecord(CommonObjectDataSubRecord other)`
`CommonObjectDataSubRecord(LittleEndianInput in, int size)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CommonObjectDataSubRecord`	`copy()`
`protected int`	`getDataSize()`
`java.util.Map<java.lang.String,java.util.function.Supplier<?>>`	`getGenericProperties()`
`SubRecord.SubRecordTypes`	`getGenericRecordType()`
`int`	`getObjectId()` Get the object id field for the CommonObjectData record.
`short`	`getObjectType()` Get the object type field for the CommonObjectData record.
`short`	`getOption()` Get the option field for the CommonObjectData record.
`int`	`getReserved1()` Get the reserved1 field for the CommonObjectData record.
`int`	`getReserved2()` Get the reserved2 field for the CommonObjectData record.
`int`	`getReserved3()` Get the reserved3 field for the CommonObjectData record.
`short`	`getSid()`
`boolean`	`isAutofill()` whether object uses an automatic fill style
`boolean`	`isAutoline()` whether object uses an automatic line style
`boolean`	`isLocked()` true if object is locked when sheet has been protected
`boolean`	`isPrintable()` object appears when printed
`void`	`serialize(LittleEndianOutput out)`
`void`	`setAutofill(boolean value)` Sets the autofill field value.
`void`	`setAutoline(boolean value)` Sets the autoline field value.
`void`	`setLocked(boolean value)` Sets the locked field value.
`void`	`setObjectId(int field_2_objectId)` Set the object id field for the CommonObjectData record.
`void`	`setObjectType(short field_1_objectType)` Set the object type field for the CommonObjectData record.
`void`	`setOption(short field_3_option)` Set the option field for the CommonObjectData record.
`void`	`setPrintable(boolean value)` Sets the printable field value.
`void`	`setReserved1(int field_4_reserved1)` Set the reserved1 field for the CommonObjectData record.
`void`	`setReserved2(int field_5_reserved2)` Set the reserved2 field for the CommonObjectData record.
`void`	`setReserved3(int field_6_reserved3)` Set the reserved3 field for the CommonObjectData record.

Methods inherited from class org.apache.poi.hssf.record.SubRecord
createSubRecord, isTerminating, serialize, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren

- Field Detail
  - sid
```
public static final short sid
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_GROUP
```
public static final short OBJECT_TYPE_GROUP
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_LINE
```
public static final short OBJECT_TYPE_LINE
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_RECTANGLE
```
public static final short OBJECT_TYPE_RECTANGLE
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_OVAL
```
public static final short OBJECT_TYPE_OVAL
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_ARC
```
public static final short OBJECT_TYPE_ARC
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_CHART
```
public static final short OBJECT_TYPE_CHART
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_TEXT
```
public static final short OBJECT_TYPE_TEXT
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_BUTTON
```
public static final short OBJECT_TYPE_BUTTON
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_PICTURE
```
public static final short OBJECT_TYPE_PICTURE
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_POLYGON
```
public static final short OBJECT_TYPE_POLYGON
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_RESERVED1
```
public static final short OBJECT_TYPE_RESERVED1
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_CHECKBOX
```
public static final short OBJECT_TYPE_CHECKBOX
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_OPTION_BUTTON
```
public static final short OBJECT_TYPE_OPTION_BUTTON
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_EDIT_BOX
```
public static final short OBJECT_TYPE_EDIT_BOX
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_LABEL
```
public static final short OBJECT_TYPE_LABEL
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_DIALOG_BOX
```
public static final short OBJECT_TYPE_DIALOG_BOX
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_SPINNER
```
public static final short OBJECT_TYPE_SPINNER
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_SCROLL_BAR
```
public static final short OBJECT_TYPE_SCROLL_BAR
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_LIST_BOX
```
public static final short OBJECT_TYPE_LIST_BOX
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_GROUP_BOX
```
public static final short OBJECT_TYPE_GROUP_BOX
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_COMBO_BOX
```
public static final short OBJECT_TYPE_COMBO_BOX
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_RESERVED2
```
public static final short OBJECT_TYPE_RESERVED2
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_RESERVED3
```
public static final short OBJECT_TYPE_RESERVED3
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_RESERVED4
```
public static final short OBJECT_TYPE_RESERVED4
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_RESERVED5
```
public static final short OBJECT_TYPE_RESERVED5
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_COMMENT
```
public static final short OBJECT_TYPE_COMMENT
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_RESERVED6
```
public static final short OBJECT_TYPE_RESERVED6
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_RESERVED7
```
public static final short OBJECT_TYPE_RESERVED7
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_RESERVED8
```
public static final short OBJECT_TYPE_RESERVED8
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_RESERVED9
```
public static final short OBJECT_TYPE_RESERVED9
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING
```
public static final short OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CommonObjectDataSubRecord
```
public CommonObjectDataSubRecord()
```
  - CommonObjectDataSubRecord
```
public CommonObjectDataSubRecord(CommonObjectDataSubRecord other)
```
  - CommonObjectDataSubRecord
```
public CommonObjectDataSubRecord(LittleEndianInput in,
                                 int size)
```
- Method Detail
  - serialize
```
public void serialize(LittleEndianOutput out)
```
    Specified by:
    
    serialize in class SubRecord
  - getDataSize
```
protected int getDataSize()
```
    Specified by:
    
    getDataSize in class SubRecord
    
    Returns:
    
    the size of the data for this record (which is always 4 bytes less than the total record size). Note however, that ushort encoded after the record sid is usually but not always the data size.
  - getSid
```
public short getSid()
```
    Returns:
    
    the record sid
  - copy
```
public CommonObjectDataSubRecord copy()
```
    Specified by:
    
    copy in interface Duplicatable
    
    Specified by:
    
    copy in class SubRecord
    
    Returns:
    
    a deep copy of the implementing class / instance
  - 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 int getObjectId()
```
    Get the object id field for the CommonObjectData record.
    
    Returns:
    
    the object id field
  - setObjectId
```
public void setObjectId(int field_2_objectId)
```
    Set the object id field for the CommonObjectData record.
    
    Parameters:
    
    field_2_objectId - the object id field
  - getOption
```
public short getOption()
```
    Get the option field for the CommonObjectData record.
    
    Returns:
    
    the option field
  - setOption
```
public void setOption(short field_3_option)
```
    Set the option field for the CommonObjectData record.
    
    Parameters:
    
    field_3_option - the option field
  - getReserved1
```
public int getReserved1()
```
    Get the reserved1 field for the CommonObjectData record.
    
    Returns:
    
    the reserved1 field
  - setReserved1
```
public void setReserved1(int field_4_reserved1)
```
    Set the reserved1 field for the CommonObjectData record.
    
    Parameters:
    
    field_4_reserved1 - the reserved1 field
  - getReserved2
```
public int getReserved2()
```
    Get the reserved2 field for the CommonObjectData record.
    
    Returns:
    
    the reserved2 field
  - setReserved2
```
public void setReserved2(int field_5_reserved2)
```
    Set the reserved2 field for the CommonObjectData record.
    
    Parameters:
    
    field_5_reserved2 - the reserved2 field
  - getReserved3
```
public int getReserved3()
```
    Get the reserved3 field for the CommonObjectData record.
    
    Returns:
    
    the reserved3 field
  - setReserved3
```
public void setReserved3(int field_6_reserved3)
```
    Set the reserved3 field for the CommonObjectData record.
    
    Parameters:
    
    field_6_reserved3 - the reserved3 field
  - setLocked
```
public void setLocked(boolean value)
```
    Sets the locked field value. true if object is locked when sheet has been protected
    
    Parameters:
    
    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
    
    Parameters:
    
    value - true if 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
    
    Parameters:
    
    value - true if 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
    
    Parameters:
    
    value - true if object uses an automatic line style
  - isAutoline
```
public boolean isAutoline()
```
    whether object uses an automatic line style
    
    Returns:
    
    the autoline field value.
  - getGenericRecordType
```
public SubRecord.SubRecordTypes getGenericRecordType()
```
    Specified by:
    
    getGenericRecordType in interface GenericRecord
    
    Specified by:
    
    getGenericRecordType in class SubRecord
  - getGenericProperties
```
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
```

Class CommonObjectDataSubRecord

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.hssf.record.SubRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.hssf.record.SubRecord

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

Field Detail

sid

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

Constructor Detail

CommonObjectDataSubRecord

CommonObjectDataSubRecord

CommonObjectDataSubRecord

Method Detail

serialize

getDataSize

getSid

copy

getObjectType

setObjectType

getObjectId

setObjectId

getOption

setOption

getReserved1

setReserved1

getReserved2

setReserved2

getReserved3

setReserved3

setLocked

isLocked

setPrintable

isPrintable

setAutofill

isAutofill

setAutoline

isAutoline

getGenericRecordType

getGenericProperties