public final class EscherDggRecord extends EscherRecord
Modifier and Type | Class and Description |
---|---|
static class |
EscherDggRecord.FileIdCluster |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
RECORD_DESCRIPTION |
static short |
RECORD_ID |
Constructor and Description |
---|
EscherDggRecord() |
Modifier and Type | Method and Description |
---|---|
void |
addCluster(int dgId,
int numShapedUsed)
Add a new cluster
|
void |
addCluster(int dgId,
int numShapedUsed,
boolean sort)
Add a new cluster
|
int |
fillFields(byte[] data,
int offset,
EscherRecordFactory recordFactory)
The contract of this method is to deserialize an escher record including
it's children.
|
int |
getDrawingsSaved()
Gets the number of drawings saved
|
EscherDggRecord.FileIdCluster[] |
getFileIdClusters() |
int |
getMaxDrawingGroupId()
Gets the maximum drawing group ID
|
int |
getNumIdClusters()
Number of id clusters + 1
|
int |
getNumShapesSaved()
Gets the number of shapes saved
|
short |
getRecordId()
Return the current record id.
|
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 |
getShapeIdMax()
Gets the next available shape id
|
int |
serialize(int offset,
byte[] data,
EscherSerializationListener listener)
Serializes the record to an existing byte array.
|
void |
setDrawingsSaved(int drawingsSaved)
Sets the number of drawings saved
|
void |
setFileIdClusters(EscherDggRecord.FileIdCluster[] fileIdClusters)
Sets the file id clusters
|
void |
setMaxDrawingGroupId(int id)
Sets the maximum drawing group ID
|
void |
setNumShapesSaved(int numShapesSaved)
Sets the number of shapes saved
|
void |
setShapeIdMax(int shapeIdMax)
The maximum is actually the next available shape id.
|
java.lang.String |
toString() |
java.lang.String |
toXml(java.lang.String tab) |
clone, display, fillFields, formatXmlRecordHeader, getChild, getChildRecords, getInstance, getOptions, getVersion, isContainerRecord, readHeader, readInstance, serialize, serialize, setChildRecords, setInstance, setOptions, setRecordId, setVersion, toXml
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 getRecordId()
EscherRecord
getRecordId
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.lang.String toXml(java.lang.String tab)
toXml
in class EscherRecord
tab
- - each children must be a right of his parentpublic int getShapeIdMax()
public void setShapeIdMax(int shapeIdMax)
shapeIdMax
- the next available shape idpublic int getNumIdClusters()
public int getNumShapesSaved()
public void setNumShapesSaved(int numShapesSaved)
numShapesSaved
- the number of shapes savedpublic int getDrawingsSaved()
public void setDrawingsSaved(int drawingsSaved)
drawingsSaved
- the number of drawings savedpublic int getMaxDrawingGroupId()
public void setMaxDrawingGroupId(int id)
id
- the maximum drawing group IDpublic EscherDggRecord.FileIdCluster[] getFileIdClusters()
public void setFileIdClusters(EscherDggRecord.FileIdCluster[] fileIdClusters)
fileIdClusters
- the file id clusterspublic void addCluster(int dgId, int numShapedUsed)
dgId
- id of the drawing group (stored in the record options)numShapedUsed
- initial value of the numShapedUsed fieldpublic void addCluster(int dgId, int numShapedUsed, boolean sort)
dgId
- id of the drawing group (stored in the record options)numShapedUsed
- initial value of the numShapedUsed fieldsort
- if true then sort clusters by drawing group id.(
In Excel the clusters are sorted but in PPT they are not)Copyright 2018 The Apache Software Foundation or its licensors, as applicable.