Package org.apache.poi.hssf.record
Class CommonObjectDataSubRecord
java.lang.Object
org.apache.poi.hssf.record.SubRecord
org.apache.poi.hssf.record.CommonObjectDataSubRecord
- All Implemented Interfaces:
Cloneable
The common object data record is used to store all common preferences for an excel object.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
protected int
int
Get the object id field for the CommonObjectData record.short
Get the object type field for the CommonObjectData record.short
Get the option field for the CommonObjectData record.int
Get the reserved1 field for the CommonObjectData record.int
Get the reserved2 field for the CommonObjectData record.int
Get the reserved3 field for the CommonObjectData record.short
getSid()
boolean
whether object uses an automatic fill styleboolean
whether object uses an automatic line styleboolean
isLocked()
true if object is locked when sheet has been protectedboolean
object appears when printedvoid
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.toString()
Methods inherited from class org.apache.poi.hssf.record.SubRecord
createSubRecord, isTerminating, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
OBJECT_TYPE_GROUP
public static final short OBJECT_TYPE_GROUP- See Also:
-
OBJECT_TYPE_LINE
public static final short OBJECT_TYPE_LINE- See Also:
-
OBJECT_TYPE_RECTANGLE
public static final short OBJECT_TYPE_RECTANGLE- See Also:
-
OBJECT_TYPE_OVAL
public static final short OBJECT_TYPE_OVAL- See Also:
-
OBJECT_TYPE_ARC
public static final short OBJECT_TYPE_ARC- See Also:
-
OBJECT_TYPE_CHART
public static final short OBJECT_TYPE_CHART- See Also:
-
OBJECT_TYPE_TEXT
public static final short OBJECT_TYPE_TEXT- See Also:
-
OBJECT_TYPE_BUTTON
public static final short OBJECT_TYPE_BUTTON- See Also:
-
OBJECT_TYPE_PICTURE
public static final short OBJECT_TYPE_PICTURE- See Also:
-
OBJECT_TYPE_POLYGON
public static final short OBJECT_TYPE_POLYGON- See Also:
-
OBJECT_TYPE_RESERVED1
public static final short OBJECT_TYPE_RESERVED1- See Also:
-
OBJECT_TYPE_CHECKBOX
public static final short OBJECT_TYPE_CHECKBOX- See Also:
-
OBJECT_TYPE_OPTION_BUTTON
public static final short OBJECT_TYPE_OPTION_BUTTON- See Also:
-
OBJECT_TYPE_EDIT_BOX
public static final short OBJECT_TYPE_EDIT_BOX- See Also:
-
OBJECT_TYPE_LABEL
public static final short OBJECT_TYPE_LABEL- See Also:
-
OBJECT_TYPE_DIALOG_BOX
public static final short OBJECT_TYPE_DIALOG_BOX- See Also:
-
OBJECT_TYPE_SPINNER
public static final short OBJECT_TYPE_SPINNER- See Also:
-
OBJECT_TYPE_SCROLL_BAR
public static final short OBJECT_TYPE_SCROLL_BAR- See Also:
-
OBJECT_TYPE_LIST_BOX
public static final short OBJECT_TYPE_LIST_BOX- See Also:
-
OBJECT_TYPE_GROUP_BOX
public static final short OBJECT_TYPE_GROUP_BOX- See Also:
-
OBJECT_TYPE_COMBO_BOX
public static final short OBJECT_TYPE_COMBO_BOX- See Also:
-
OBJECT_TYPE_RESERVED2
public static final short OBJECT_TYPE_RESERVED2- See Also:
-
OBJECT_TYPE_RESERVED3
public static final short OBJECT_TYPE_RESERVED3- See Also:
-
OBJECT_TYPE_RESERVED4
public static final short OBJECT_TYPE_RESERVED4- See Also:
-
OBJECT_TYPE_RESERVED5
public static final short OBJECT_TYPE_RESERVED5- See Also:
-
OBJECT_TYPE_COMMENT
public static final short OBJECT_TYPE_COMMENT- See Also:
-
OBJECT_TYPE_RESERVED6
public static final short OBJECT_TYPE_RESERVED6- See Also:
-
OBJECT_TYPE_RESERVED7
public static final short OBJECT_TYPE_RESERVED7- See Also:
-
OBJECT_TYPE_RESERVED8
public static final short OBJECT_TYPE_RESERVED8- See Also:
-
OBJECT_TYPE_RESERVED9
public static final short OBJECT_TYPE_RESERVED9- See Also:
-
OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING
public static final short OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING- See Also:
-
-
Constructor Details
-
CommonObjectDataSubRecord
public CommonObjectDataSubRecord() -
CommonObjectDataSubRecord
-
-
Method Details
-
toString
-
serialize
-
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classSubRecord
- 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
-
clone
-
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.
-