Package org.apache.poi.ddf
Class EscherDgRecord
java.lang.Object
org.apache.poi.ddf.EscherRecord
org.apache.poi.ddf.EscherDgRecord
- All Implemented Interfaces:
Cloneable
This record simply holds the number of shapes in the drawing group and the
last shape id used for this drawing group.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintfillFields(byte[] data, int offset, EscherRecordFactory recordFactory) The contract of this method is to deserialize an escher record including it's children.protected Object[][]For the purpose of providing toString() and toXml() a subclass can either override those methods or provide a Object[][] array in the form{ { "Attribute Name (Header)", value, "optional attribute", value }, ... }.shortGets the drawing group id for this record.intThe last shape id used in this drawing group.intThe number of shapes in this drawing group.shortReturn the current record id.Subclasses should return the short name for this escher record.intReturns the number of bytes that are required to serialize this record.voidIncrements the number of shapesintserialize(int offset, byte[] data, EscherSerializationListener listener) Serializes the record to an existing byte array.voidsetLastMSOSPID(int field_2_lastMSOSPID) The last shape id used in this drawing group.voidsetNumShapes(int field_1_numShapes) The number of shapes in this drawing group.Methods inherited from class org.apache.poi.ddf.EscherRecord
clone, display, fillFields, getChild, getChildRecords, getInstance, getOptions, getVersion, isContainerRecord, readHeader, readInstance, serialize, serialize, setChildRecords, setInstance, setOptions, setRecordId, setVersion, toString, toXml, toXml
-
Field Details
-
RECORD_ID
public static final short RECORD_ID- See Also:
-
RECORD_DESCRIPTION
- See Also:
-
-
Constructor Details
-
EscherDgRecord
public EscherDgRecord()
-
-
Method Details
-
fillFields
Description copied from class:EscherRecordThe contract of this method is to deserialize an escher record including it's children.- Specified by:
fillFieldsin classEscherRecord- Parameters:
data- The byte array containing the serialized escher records.offset- The offset into the byte array.recordFactory- A factory for creating new escher records.- Returns:
- The number of bytes written.
-
serialize
Description copied from class:EscherRecordSerializes the record to an existing byte array.- Specified by:
serializein classEscherRecord- Parameters:
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.- Returns:
- the number of bytes written.
-
getRecordSize
public int getRecordSize()Returns the number of bytes that are required to serialize this record.- Specified by:
getRecordSizein classEscherRecord- Returns:
- Number of bytes
-
getRecordId
public short getRecordId()Description copied from class:EscherRecordReturn the current record id.- Overrides:
getRecordIdin classEscherRecord- Returns:
- The 16 bit record id.
-
getRecordName
Description copied from class:EscherRecordSubclasses should return the short name for this escher record.- Specified by:
getRecordNamein classEscherRecord- Returns:
- the short name for this escher record
-
getNumShapes
public int getNumShapes()The number of shapes in this drawing group.- Returns:
- the number of shapes
-
setNumShapes
public void setNumShapes(int field_1_numShapes) The number of shapes in this drawing group.- Parameters:
field_1_numShapes- the number of shapes
-
getLastMSOSPID
public int getLastMSOSPID()The last shape id used in this drawing group.- Returns:
- the last shape id
-
setLastMSOSPID
public void setLastMSOSPID(int field_2_lastMSOSPID) The last shape id used in this drawing group.- Parameters:
field_2_lastMSOSPID- the last shape id
-
getDrawingGroupId
public short getDrawingGroupId()Gets the drawing group id for this record. This is encoded in the instance part of the option record.- Returns:
- a drawing group id.
-
incrementShapeCount
public void incrementShapeCount()Increments the number of shapes -
getAttributeMap
Description copied from class:EscherRecordFor the purpose of providing toString() and toXml() a subclass can either override those methods or provide a Object[][] array in the form{ { "Attribute Name (Header)", value, "optional attribute", value }, ... }.Null values won't be printed.
The attributes record, version, instance, options must not be returned.
- Specified by:
getAttributeMapin classEscherRecord- Returns:
- the attribute map
-