Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.CommonObjectDataSubRecord

Field Summary

Modifier and Type	Field and Description
private static final BitField	autofill
private static final BitField	autoline
private short	field_1_objectType
private int	field_2_objectId
private short	field_3_option
private int	field_4_reserved1
private int	field_5_reserved2
private int	field_6_reserved3
private static final BitField	locked
public static final short	OBJECT_TYPE_ARC
public static final short	OBJECT_TYPE_BUTTON
public static final short	OBJECT_TYPE_CHART
public static final short	OBJECT_TYPE_CHECKBOX
public static final short	OBJECT_TYPE_COMBO_BOX
public static final short	OBJECT_TYPE_COMMENT
public static final short	OBJECT_TYPE_DIALOG_BOX
public static final short	OBJECT_TYPE_EDIT_BOX
public static final short	OBJECT_TYPE_GROUP
public static final short	OBJECT_TYPE_GROUP_BOX
public static final short	OBJECT_TYPE_LABEL
public static final short	OBJECT_TYPE_LINE
public static final short	OBJECT_TYPE_LIST_BOX
public static final short	OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING
public static final short	OBJECT_TYPE_OPTION_BUTTON
public static final short	OBJECT_TYPE_OVAL
public static final short	OBJECT_TYPE_PICTURE
public static final short	OBJECT_TYPE_POLYGON
public static final short	OBJECT_TYPE_RECTANGLE
public static final short	OBJECT_TYPE_RESERVED1
public static final short	OBJECT_TYPE_RESERVED2
public static final short	OBJECT_TYPE_RESERVED3
public static final short	OBJECT_TYPE_RESERVED4
public static final short	OBJECT_TYPE_RESERVED5
public static final short	OBJECT_TYPE_RESERVED6
public static final short	OBJECT_TYPE_RESERVED7
public static final short	OBJECT_TYPE_RESERVED8
public static final short	OBJECT_TYPE_RESERVED9
public static final short	OBJECT_TYPE_SCROLL_BAR
public static final short	OBJECT_TYPE_SPINNER
public static final short	OBJECT_TYPE_TEXT
private static final BitField	printable
public static final short	sid

Constructor Summary

Access	Constructor and Description
public	CommonObjectDataSubRecord()
public	CommonObjectDataSubRecord(CommonObjectDataSubRecord other)
public	CommonObjectDataSubRecord(LittleEndianInput in, int size)
pack-priv	CommonObjectDataSubRecord(LittleEndianInput in, int size, int cmoOt)

Method Summary

Modifier and Type	Method and Description
public CommonObjectDataSubRecord	copy() Implements abstract org.apache.poi.hssf.record.SubRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.SubRecord.getDataSize.
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public SubRecord.SubRecordTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.SubRecord.getGenericRecordType.
public int	Returns: the object id field getObjectId() Get the object id field for the CommonObjectData record.
public short	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 getObjectType() Get the object type field for the CommonObjectData record.
public short	Returns: the option field getOption() Get the option field for the CommonObjectData record.
public int	Returns: the reserved1 field getReserved1() Get the reserved1 field for the CommonObjectData record.
public int	Returns: the reserved2 field getReserved2() Get the reserved2 field for the CommonObjectData record.
public int	Returns: the reserved3 field getReserved3() Get the reserved3 field for the CommonObjectData record.
public short	Returns: the record sid getSid()
public boolean	Returns: the autofill field value. isAutofill() whether object uses an automatic fill style
public boolean	Returns: the autoline field value. isAutoline() whether object uses an automatic line style
public boolean	Returns: the locked field value. isLocked() true if object is locked when sheet has been protected
public boolean	Returns: the printable field value. isPrintable() object appears when printed
public void	serialize(LittleEndianOutput out) Implements abstract org.apache.poi.hssf.record.SubRecord.serialize.
public void	setAutofill(boolean `true` if object uses an automatic fill style value) Sets the autofill field value.
public void	setAutoline(boolean `true` if object uses an automatic line style value) Sets the autoline field value.
public void	setLocked(boolean `true` if object is locked when sheet has been protected value) Sets the locked field value.
public void	setObjectId(int the object id field field_2_objectId) Set the object id field for the CommonObjectData record.
public void	setObjectType(short 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 field_1_objectType) Set the object type field for the CommonObjectData record.
public void	setOption(short the option field field_3_option) Set the option field for the CommonObjectData record.
public void	setPrintable(boolean `true` if object appears when printed value) Sets the printable field value.
public void	setReserved1(int the reserved1 field field_4_reserved1) Set the reserved1 field for the CommonObjectData record.
public void	setReserved2(int the reserved2 field field_5_reserved2) Set the reserved2 field for the CommonObjectData record.
public void	setReserved3(int the reserved3 field field_6_reserved3) Set the reserved3 field for the CommonObjectData record.

Inherited from org.apache.poi.hssf.record.SubRecord:: createSubRecord getMaxRecordLength isTerminating serialize setMaxRecordLength toString

Field Detail

autofill	back to summary
private static final BitField autofill

autoline	back to summary
private static final BitField autoline

field_1_objectType	back to summary
private short field_1_objectType

field_2_objectId	back to summary
private int field_2_objectId

field_3_option	back to summary
private short field_3_option

field_4_reserved1	back to summary
private int field_4_reserved1

field_5_reserved2	back to summary
private int field_5_reserved2

field_6_reserved3	back to summary
private int field_6_reserved3

locked	back to summary
private static final BitField locked

OBJECT_TYPE_ARC	back to summary
public static final short OBJECT_TYPE_ARC

OBJECT_TYPE_BUTTON	back to summary
public static final short OBJECT_TYPE_BUTTON

OBJECT_TYPE_CHART	back to summary
public static final short OBJECT_TYPE_CHART

OBJECT_TYPE_CHECKBOX	back to summary
public static final short OBJECT_TYPE_CHECKBOX

OBJECT_TYPE_COMBO_BOX	back to summary
public static final short OBJECT_TYPE_COMBO_BOX

OBJECT_TYPE_COMMENT	back to summary
public static final short OBJECT_TYPE_COMMENT

OBJECT_TYPE_DIALOG_BOX	back to summary
public static final short OBJECT_TYPE_DIALOG_BOX

OBJECT_TYPE_EDIT_BOX	back to summary
public static final short OBJECT_TYPE_EDIT_BOX

OBJECT_TYPE_GROUP	back to summary
public static final short OBJECT_TYPE_GROUP

OBJECT_TYPE_GROUP_BOX	back to summary
public static final short OBJECT_TYPE_GROUP_BOX

OBJECT_TYPE_LABEL	back to summary
public static final short OBJECT_TYPE_LABEL

OBJECT_TYPE_LINE	back to summary
public static final short OBJECT_TYPE_LINE

OBJECT_TYPE_LIST_BOX	back to summary
public static final short OBJECT_TYPE_LIST_BOX

OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING	back to summary
public static final short OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING

OBJECT_TYPE_OPTION_BUTTON	back to summary
public static final short OBJECT_TYPE_OPTION_BUTTON

OBJECT_TYPE_OVAL	back to summary
public static final short OBJECT_TYPE_OVAL

OBJECT_TYPE_PICTURE	back to summary
public static final short OBJECT_TYPE_PICTURE

OBJECT_TYPE_POLYGON	back to summary
public static final short OBJECT_TYPE_POLYGON

OBJECT_TYPE_RECTANGLE	back to summary
public static final short OBJECT_TYPE_RECTANGLE

OBJECT_TYPE_RESERVED1	back to summary
public static final short OBJECT_TYPE_RESERVED1

OBJECT_TYPE_RESERVED2	back to summary
public static final short OBJECT_TYPE_RESERVED2

OBJECT_TYPE_RESERVED3	back to summary
public static final short OBJECT_TYPE_RESERVED3

OBJECT_TYPE_RESERVED4	back to summary
public static final short OBJECT_TYPE_RESERVED4

OBJECT_TYPE_RESERVED5	back to summary
public static final short OBJECT_TYPE_RESERVED5

OBJECT_TYPE_RESERVED6	back to summary
public static final short OBJECT_TYPE_RESERVED6

OBJECT_TYPE_RESERVED7	back to summary
public static final short OBJECT_TYPE_RESERVED7

OBJECT_TYPE_RESERVED8	back to summary
public static final short OBJECT_TYPE_RESERVED8

OBJECT_TYPE_RESERVED9	back to summary
public static final short OBJECT_TYPE_RESERVED9

OBJECT_TYPE_SCROLL_BAR	back to summary
public static final short OBJECT_TYPE_SCROLL_BAR

OBJECT_TYPE_SPINNER	back to summary
public static final short OBJECT_TYPE_SPINNER

OBJECT_TYPE_TEXT	back to summary
public static final short OBJECT_TYPE_TEXT

printable	back to summary
private static final BitField printable

sid	back to summary
public static final short sid

Constructor Detail

CommonObjectDataSubRecord	back to summary
public CommonObjectDataSubRecord()

CommonObjectDataSubRecord	back to summary
public CommonObjectDataSubRecord(CommonObjectDataSubRecord other)

CommonObjectDataSubRecord	back to summary
public CommonObjectDataSubRecord(LittleEndianInput in, int size)

CommonObjectDataSubRecord	back to summary
pack-priv CommonObjectDataSubRecord(LittleEndianInput in, int size, int cmoOt)

Method Detail

copy	back to summary
public CommonObjectDataSubRecord copy() Implements abstract org.apache.poi.hssf.record.SubRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:CommonObjectDataSubRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public CommonObjectDataSubRecord copy()

Implements abstract org.apache.poi.hssf.record.SubRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:CommonObjectDataSubRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

getDataSize

back to summary

protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.SubRecord.getDataSize.

Returns:int

Doc from org.apache.poi.hssf.record.SubRecord.getDataSize.

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.

Annotations

@Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType

back to summary

public SubRecord.SubRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.SubRecord.getGenericRecordType.

Annotations

@Override

getObjectId

back to summary

public int getObjectId()

Get the object id field for the CommonObjectData record.

Returns:int: the object id field

getObjectType

back to summary

public short getObjectType()

Get the object type field for the CommonObjectData record.

Returns:short: 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

getOption

back to summary

public short getOption()

Get the option field for the CommonObjectData record.

Returns:short: the option field

getReserved1

back to summary

public int getReserved1()

Get the reserved1 field for the CommonObjectData record.

Returns:int: the reserved1 field

getReserved2

back to summary

public int getReserved2()

Get the reserved2 field for the CommonObjectData record.

Returns:int: the reserved2 field

getReserved3

back to summary

public int getReserved3()

Get the reserved3 field for the CommonObjectData record.

Returns:int: the reserved3 field

getSid	back to summary
public short getSid() Returns:short the record sid

isAutofill

back to summary

public boolean isAutofill()

whether object uses an automatic fill style

Returns:boolean: the autofill field value.

isAutoline

back to summary

public boolean isAutoline()

whether object uses an automatic line style

Returns:boolean: the autoline field value.

isLocked

back to summary

public boolean isLocked()

true if object is locked when sheet has been protected

Returns:boolean: the locked field value.

isPrintable

back to summary

public boolean isPrintable()

object appears when printed

Returns:boolean: the printable field value.

serialize

back to summary

public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.SubRecord.serialize.

Annotations

@Override

setAutofill back to summary

public void setAutofill(boolean value)

Sets the autofill field value. whether object uses an automatic fill style

Parameters

value:boolean: true if object uses an automatic fill style

setAutoline back to summary

public void setAutoline(boolean value)

Sets the autoline field value. whether object uses an automatic line style

Parameters

value:boolean: true if object uses an automatic line style

setLocked back to summary

public void setLocked(boolean value)

Sets the locked field value. true if object is locked when sheet has been protected

Parameters

value:boolean: true if object is locked when sheet has been protected

setObjectId

back to summary

public void setObjectId(int field_2_objectId)

Set the object id field for the CommonObjectData record.

Parameters

field_2_objectId:int: the object id field

setObjectType

back to summary

public void setObjectType(short field_1_objectType)

Set the object type field for the CommonObjectData record.

Parameters

field_1_objectType:short: 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

setOption

back to summary

public void setOption(short field_3_option)

Set the option field for the CommonObjectData record.

Parameters

field_3_option:short: the option field

setPrintable back to summary

public void setPrintable(boolean value)

Sets the printable field value. object appears when printed

Parameters

value:boolean: true if object appears when printed

setReserved1

back to summary

public void setReserved1(int field_4_reserved1)

Set the reserved1 field for the CommonObjectData record.

Parameters

field_4_reserved1:int: the reserved1 field

setReserved2

back to summary

public void setReserved2(int field_5_reserved2)

Set the reserved2 field for the CommonObjectData record.

Parameters

field_5_reserved2:int: the reserved2 field

setReserved3

back to summary

public void setReserved3(int field_6_reserved3)

Set the reserved3 field for the CommonObjectData record.

Parameters

field_6_reserved3:int: the reserved3 field

public final Class CommonObjectDataSubRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail