|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.ddf.EscherRecord org.apache.poi.ddf.AbstractEscherOptRecord
public abstract class AbstractEscherOptRecord
Common abstract class for EscherOptRecord
and
EscherTertiaryOptRecord
Field Summary | |
---|---|
protected java.util.List<EscherProperty> |
properties
|
Constructor Summary | |
---|---|
AbstractEscherOptRecord()
|
Method Summary | ||
---|---|---|
void |
addEscherProperty(EscherProperty prop)
Add a property to this record. |
|
int |
fillFields(byte[] data,
int offset,
EscherRecordFactory recordFactory)
The contract of this method is to deserialize an escher record including it's children. |
|
java.util.List<EscherProperty> |
getEscherProperties()
The list of properties stored by this record. |
|
EscherProperty |
getEscherProperty(int index)
The list of properties stored by this record. |
|
int |
getRecordSize()
Subclasses should effeciently return the number of bytes required to serialize the record. |
|
|
lookup(int propId)
|
|
int |
serialize(int offset,
byte[] data,
EscherSerializationListener listener)
Serializes the record to an existing 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, getOptions, getRecordId, getRecordName, getVersion, isContainerRecord, readHeader, readInstance, serialize, serialize, setChildRecords, setInstance, setOptions, setRecordId, setVersion |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.util.List<EscherProperty> properties
Constructor Detail |
---|
public AbstractEscherOptRecord()
Method Detail |
---|
public void addEscherProperty(EscherProperty prop)
public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
EscherRecord
fillFields
in class EscherRecord
data
- The byte array containing the serialized escher
records.offset
- The offset into the byte array.recordFactory
- A factory for creating new escher records.
public java.util.List<EscherProperty> getEscherProperties()
public EscherProperty getEscherProperty(int index)
public int getRecordSize()
EscherRecord
getRecordSize
in class EscherRecord
public <T extends EscherProperty> T lookup(int propId)
public int serialize(int offset, byte[] data, EscherSerializationListener listener)
EscherRecord
serialize
in class EscherRecord
offset
- the offset within the byte arraydata
- the data array to serialize tolistener
- a listener for begin and end serialization events. This
is useful because the serialization is
hierarchical/recursive and sometimes you need to be able
break into that.
public void sortProperties()
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |