org.apache.poi.ddf
public class EscherOptRecord extends EscherRecord
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
RECORD_DESCRIPTION |
static short |
RECORD_ID |
Constructor and Description |
---|
EscherOptRecord() |
Modifier and Type | Method and Description |
---|---|
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 |
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()
Subclasses should return the short name for this escher record.
|
int |
getRecordSize()
Subclasses should effeciently return the number of bytes required to
serialize the record.
|
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.
|
clone, display, fillFields, getChild, getChildRecords, getInstance, getRecordId, isContainerRecord, readHeader, serialize, serialize, setChildRecords, setOptions, setRecordId
public static final short RECORD_ID
public static final java.lang.String RECORD_DESCRIPTION
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 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 int getRecordSize()
EscherRecord
getRecordSize
in class EscherRecord
public short getOptions()
getOptions
in class EscherRecord
public java.lang.String getRecordName()
EscherRecord
getRecordName
in class EscherRecord
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.List getEscherProperties()
public EscherProperty getEscherProperty(int index)
public void addEscherProperty(EscherProperty prop)
public void sortProperties()
Copyright 2016 The Apache Software Foundation or its licensors, as applicable.