| java.lang.Object
 org.apache.poi.ddf.EscherRecord
org.apache.poi.ddf.EscherOptRecord
| EscherOptRecord | | public class EscherOptRecord extends EscherRecord (Code) | | 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 |
| Method Summary | |
| public void | addEscherProperty(EscherProperty prop)
Add a property to this record. | | public int | fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
This method deserializes the record from a byte array.
Parameters:
data - The byte array containing the escher record information
Parameters:
offset - The starting offset into data.
Parameters:
recordFactory - May be null since this is not a container record. | | public List | getEscherProperties()
The list of properties stored by this record. | | public EscherProperty | getEscherProperty(int index)
The list of properties stored by this record. | | public short | getOptions()
| | public String | getRecordName()
| | public int | getRecordSize()
Returns the number of bytes that are required to serialize this record. | | public int | serialize(int offset, byte[] data, EscherSerializationListener listener)
This method serializes this escher record into a byte array.
Parameters:
offset - The offset into data to start writing the record data to.
Parameters:
data - The byte array to serialize to.
Parameters:
listener - A listener to retrieve start and end callbacks. | | public void | sortProperties()
Records should be sorted by property number before being stored. | | public String | toString()
Retrieve the string representation of this record. |
| RECORD_DESCRIPTION | | final public static String RECORD_DESCRIPTION(Code) | | |
| RECORD_ID | | final public static short RECORD_ID(Code) | | |
| addEscherProperty | | public void addEscherProperty(EscherProperty prop)(Code) | | Add a property to this record.
|
| fillFields | | public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)(Code) | | This method deserializes the record from a byte array.
Parameters:
data - The byte array containing the escher record information
Parameters:
offset - The starting offset into data.
Parameters:
recordFactory - May be null since this is not a container record. The number of bytes read from the byte array. |
| getEscherProperties | | public List getEscherProperties()(Code) | | The list of properties stored by this record.
|
| getEscherProperty | | public EscherProperty getEscherProperty(int index)(Code) | | The list of properties stored by this record.
|
| getOptions | | public short getOptions()(Code) | | Automatically recalculate the correct option
|
| getRecordName | | public String getRecordName()(Code) | | The short name for this record
|
| getRecordSize | | public int getRecordSize()(Code) | | Returns the number of bytes that are required to serialize this record.
Number of bytes |
| serialize | | public int serialize(int offset, byte[] data, EscherSerializationListener listener)(Code) | | This method serializes this escher record into a byte array.
Parameters:
offset - The offset into data to start writing the record data to.
Parameters:
data - The byte array to serialize to.
Parameters:
listener - A listener to retrieve start and end callbacks. Use a NullEscherSerailizationListener to ignore these events. The number of bytes written.
See Also: NullEscherSerializationListener |
| sortProperties | | public void sortProperties()(Code) | | Records should be sorted by property number before being stored.
|
| toString | | public String toString()(Code) | | Retrieve the string representation of this record.
|
|
|