Package loci.poi.ddf
Class EscherOptRecord
java.lang.Object
loci.poi.ddf.EscherRecord
loci.poi.ddf.EscherOptRecord
The opt record is used to store property values for a shape. It is the key to determining
the attributes of a shape. Properties can be of two types: simple or complex. Simple types
are fixed length. Complex properties are variable length.
- Author:
- Glen Stampoultzis
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a property to this record.intfillFields(byte[] data, int offset, EscherRecordFactory recordFactory) This method deserializes the record from a byte array.The list of properties stored by this record.getEscherProperty(int index) The list of properties stored by this record.shortAutomatically recalculate the correct optionThe short name for this recordintReturns the number of bytes that are required to serialize this record.intserialize(int offset, byte[] data, EscherSerializationListener listener) This method serializes this escher record into a byte array.voidRecords should be sorted by property number before being stored.toString()Retrieve the string representation of this record.Methods inherited from class loci.poi.ddf.EscherRecord
clone, display, fillFields, getChild, getChildRecords, getInstance, getRecordId, isContainerRecord, readHeader, serialize, serialize, setChildRecords, setOptions, setRecordId
-
Field Details
-
RECORD_ID
public static final short RECORD_ID- See Also:
-
RECORD_DESCRIPTION
- See Also:
-
-
Constructor Details
-
EscherOptRecord
public EscherOptRecord()
-
-
Method Details
-
fillFields
This method deserializes the record from a byte array.- Specified by:
fillFieldsin classEscherRecord- Parameters:
data- The byte array containing the escher record informationoffset- The starting offset intodata.recordFactory- May be null since this is not a container record.- Returns:
- The number of bytes read from the byte array.
-
serialize
This method serializes this escher record into a byte array.- Specified by:
serializein classEscherRecord- Parameters:
offset- The offset intodatato start writing the record data to.data- The byte array to serialize to.listener- A listener to retrieve start and end callbacks. Use aNullEscherSerailizationListenerto ignore these events.- Returns:
- The number of bytes written.
- See Also:
-
getRecordSize
public int getRecordSize()Returns the number of bytes that are required to serialize this record.- Specified by:
getRecordSizein classEscherRecord- Returns:
- Number of bytes
-
getOptions
public short getOptions()Automatically recalculate the correct option- Overrides:
getOptionsin classEscherRecord- Returns:
- The options field for this record. All records have one.
-
getRecordName
The short name for this record- Specified by:
getRecordNamein classEscherRecord
-
toString
Retrieve the string representation of this record. -
getEscherProperties
The list of properties stored by this record. -
getEscherProperty
The list of properties stored by this record. -
addEscherProperty
Add a property to this record. -
sortProperties
public void sortProperties()Records should be sorted by property number before being stored.
-