|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.ddf.EscherRecord
org.apache.poi.ddf.EscherOptRecord
public class 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.
| Field Summary | |
|---|---|
static java.lang.String |
RECORD_DESCRIPTION
|
static short |
RECORD_ID
|
| Constructor Summary | |
|---|---|
EscherOptRecord()
|
|
| Method Summary | |
|---|---|
void |
addEscherProperty(EscherProperty prop)
Add a property to this record. |
int |
fillFields(byte[] data,
int offset,
EscherRecordFactory recordFactory)
This method deserializes the record from a byte array. |
java.util.List |
getEscherProperties()
The list of properties stored by this record. |
EscherProperty |
getEscherProperty(int index)
The list of properties stored by this record. |
short |
getOptions()
Automatically recalculate the correct option |
java.lang.String |
getRecordName()
The short name for this record |
int |
getRecordSize()
Returns the number of bytes that are required to serialize this record. |
int |
serialize(int offset,
byte[] data,
EscherSerializationListener listener)
This method serializes this escher record into a byte array. |
void |
sortProperties()
Records should be sorted by property number before being stored. |
java.lang.String |
toString()
Retrieve the string representation of this record. |
| Methods inherited from class org.apache.poi.ddf.EscherRecord |
|---|
clone, display, fillFields, getChild, getChildRecords, getInstance, getRecordId, isContainerRecord, readHeader, serialize, serialize, setChildRecords, setOptions, setRecordId |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final short RECORD_ID
public static final java.lang.String RECORD_DESCRIPTION
| Constructor Detail |
|---|
public EscherOptRecord()
| Method Detail |
|---|
public int fillFields(byte[] data,
int offset,
EscherRecordFactory recordFactory)
fillFields in class EscherRecorddata - The byte array containing the escher record informationoffset - The starting offset into data.recordFactory - May be null since this is not a container record.
public int serialize(int offset,
byte[] data,
EscherSerializationListener listener)
serialize in class EscherRecordoffset - The offset into data to start writing the record data to.data - The byte array to serialize to.listener - A listener to retrieve start and end callbacks. Use a NullEscherSerailizationListener to ignore these events.
NullEscherSerializationListenerpublic int getRecordSize()
getRecordSize in class EscherRecordpublic short getOptions()
getOptions in class EscherRecordpublic java.lang.String getRecordName()
getRecordName in class EscherRecordpublic java.lang.String toString()
toString in class java.lang.Objectpublic java.util.List getEscherProperties()
public EscherProperty getEscherProperty(int index)
public void addEscherProperty(EscherProperty prop)
public void sortProperties()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||