NPOI.DDF
Interface for listening to escher serialization events.
@author Glen Stampoultzis (glens at apache.org)
Fired before a given escher record is Serialized.
@param offset The position in the data array at which the record will be Serialized.
@param recordId The id of the record about to be Serialized.
Fired after a record has been Serialized.
@param offset The position of the end of the Serialized record + 1
@param recordId The id of the record about to be Serialized
@param size The number of bytes written for this record. If it is a container
record then this will include the size of any included records.
This is the abstract base class for all escher properties.
@see EscherOptRecord
@author Glen Stampoultzis (glens at apache.org)
Initializes a new instance of the class.
The id is distinct from the actual property number. The id includes the property number the blip id
flag and an indicator whether the property is complex or not.
Initializes a new instance of the class.The three parameters are combined to form a property
id.
The property number.
if set to true [is complex].
if set to true [is blip id].
Escher properties consist of a simple fixed Length part and a complex variable Length part.
The fixed Length part is Serialized first.
The data.
The pos.
Escher properties consist of a simple fixed Length part and a complex variable Length part.
The fixed Length part is Serialized first.
The data.
The pos.
Gets the id.
The id.
Gets the property number.
The property number.
Gets a value indicating whether this instance is complex.
true if this instance is complex; otherwise, false.
Gets a value indicating whether this instance is blip id.
true if this instance is blip id; otherwise, false.
Gets the name.
The name.
Most properties are just 6 bytes in Length. Override this if we're
dealing with complex properties.
The size of the property.
The blip record is used to hold details about large binary objects that occur in escher such
as JPEG, GIF, PICT and WMF files. The contents of the stream is usually compressed. Inflate
can be used to decompress the data.
@author Glen Stampoultzis
@author Glen Stampoultzis
@version $Id: EscherBlipRecord.java 569827 2007-08-26 15:26:29Z yegor $
The base abstract record from which all escher records are defined. Subclasses will need
to define methods for serialization/deserialization and for determining the record size.
@author Glen Stampoultzis
Initializes a new instance of the class.
Delegates to FillFields(byte[], int, EscherRecordFactory)
The data.
The f.
The contract of this method is to deSerialize an escher record including
it's children.
The byte array containing the Serialized escher
records.
The offset into the byte array.
A factory for creating new escher records.
The number of bytes written.
Reads the 8 byte header information and populates the
options
and
recordId
records.
the byte array to Read from
the offset to start Reading from
the number of bytes remaining in this record. This
Serializes to a new byte array. This is done by delegating to
Serialize(int, byte[]);
the Serialized record.
Serializes to an existing byte array without serialization listener.
This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
the offset within the data byte array.
the data array to Serialize to.
The number of bytes written.
Serializes the record to an existing byte array.
the offset within the byte array.
the offset within the byte array
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.
Creates a new object that is a copy of the current instance.
A new object that is a copy of this instance.
Returns the indexed child record.
The index.
The display methods allows escher variables to print the record names
according to their hierarchy.
The current indent level.
Returns the instance part of the option record.
The instance part of the record
Determine whether this is a container record by inspecting the option
field.
true if this instance is container record; otherwise, false.
Gets or sets the options field for this record. All records have one
The options.
Subclasses should effeciently return the number of bytes required to
Serialize the record.
number of bytes
Return the current record id.
The 16 bit record id.
Gets or sets the child records.
Returns the children of this record. By default this will
be an empty list. EscherCotainerRecord is the only record that may contain children.
Gets the name of the record.
The name of the record.
This class Reads the standard escher header.
Reads the header.
The data.
The off set.
Returns a that represents the current .
A that represents the current .
Gets the options.
The options.
Gets the record id.
The record id.
Gets the remaining bytes.
The remaining bytes.
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into
May be null since this is not a container record.
The number of bytes Read from the byte array.
Serializes the record to an existing byte array.
the offset within the byte array
the data array to Serialize to
the number of bytes written.
Returns a that represents the current .
A that represents the current .
Returns the number of bytes that are required to Serialize this record.
Number of bytes
The short name for this record
Gets or sets the picture data.
The picture data.
This method deserializes the record from a byte array.
The byte array containing the escher record information
The starting offset into
May be null since this is not a container record.
The number of bytes Read from the byte array.
This method Serializes this escher record into a byte array.
@param offset
The offset into data to start writing the record data to.
the data array to Serialize to
the number of bytes written.
Returns a that represents the current .
A that represents the current .
Compress the contents of the provided array
An uncompressed byte array
Decompresses the specified data.
The compressed byte array.
The starting position into the byte array.
The number of compressed bytes to decompress.
An uncompressed byte array
Returns the number of bytes that are required to Serialize this record.
Number of bytes
The short name for this record
Gets or sets the secondary UID.
The secondary UID.
Gets or sets the size of the cache of.
The size of the cache of.
Gets or sets the top boundary of the metafile drawing commands
The boundary top.
Gets or sets the left boundary of the metafile drawing commands
The boundary left.
Gets or sets the boundary width of the metafile drawing commands
The width of the boundary.
Gets or sets the boundary height of the metafile drawing commands
The height of the boundary.
Gets or sets the width of the metafile in EMU's (English Metric Units).
The width.
Gets or sets the height of the metafile in EMU's (English Metric Units).
The height.
Gets or sets the cache of the saved size
the cache of the saved size.
Is the contents of the blip compressed?
The compression flag.
Gets or sets the filter.
The filter.
Gets or sets The BLIP data
The data.
Defines the constants for the various possible shape paths.
@author Glen Stampoultzis (glens at apache.org)
A simple property is of fixed Length and as a property number in Addition
to a 32-bit value. Properties that can't be stored in only 32-bits are
stored as EscherComplexProperty objects.
@author Glen Stampoultzis (glens at apache.org)
The id is distinct from the actual property number. The id includes the property number the blip id
flag and an indicator whether the property is complex or not.
The id.
The property value.
Constructs a new escher property. The three parameters are combined to form a property
id.
The property number.
if set to true [is complex].
if set to true [is blip id].
The property value.
Serialize the simple part of the escher record.
The data.
The off set.
the number of bytes Serialized.
Escher properties consist of a simple fixed Length part and a complex variable Length part.
The fixed Length part is Serialized first.
Returns true if one escher property is equal to another.
The o.
Serves as a hash function for a particular type.
A hash code for the current .
Returns a that represents the current .
A that represents the current .
Return the 32 bit value of this property.
The property value.
Initializes a new instance of the class.
The property number.
The shape path.
ToGether the the EscherOptRecord this record defines some of the basic
properties of a shape.
@author Glen Stampoultzis (glens at apache.org)
The contract of this method is to deSerialize an escher record including
it's children.
The byte array containing the Serialized escher
records.
The offset into the byte array.
A factory for creating new escher records
The number of bytes written.
Serializes to an existing byte array without serialization listener.
This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
the offset within the data byte array.
the data array to Serialize to.
The number of bytes written.
Returns a that represents the current .
A that represents the current .
Converts the shape flags into a more descriptive name.
The flags.
Returns the number of bytes that are required to Serialize this record.
Number of bytes
@return the 16 bit identifier for this record.
The short name for this record
Gets or sets A number that identifies this shape
The shape id.
The flags that apply to this shape.
The flags.
Used by records to indicate invalid format/data.
This class stores the type and description of an escher property.
@author Glen Stampoultzis (glens at apache.org)
Initializes a new instance of the class.
The description of the escher property.
Initializes a new instance of the class.
The description of the escher property.
The type of the property.
Gets the description.
The description.
Gets the type.
The type.
The BSE record is related closely to the EscherBlipRecord and stores
extra information about the blip. A blip record is actually stored inside
the BSE record even though the BSE record isn't actually a container record.
@author Glen Stampoultzis
@see EscherBlipRecord
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into data
May be null since this is not a container record.
The number of bytes Read from the byte array.
This method Serializes this escher record into a byte array.
The offset into
data to start writing the record data to
The byte array to Serialize to.
The number of bytes written.
Returns a that represents the current .
A that represents the current .
Retrieve the string representation given a blip id.
The b.
Returns the number of bytes that are required to Serialize this record.
Number of bytes
The short name for this record
Gets or sets the expected blip type under windows (failure to match this blip type will result in
Excel converting to this format).
The blip type win32.
Gets or sets the expected blip type under MacOS (failure to match this blip type will result in
Excel converting to this format).
The blip type mac OS.
Gets or sets 16 byte MD4 checksum.
The UID.
Gets or sets the tag. (Unused)
The tag.
Gets or sets Blip size in stream..
The size.
Gets or sets the reference count of this blip.
The ref.
Gets or sets the offset in the delay stream..
The offset.
Defines the way this blip is used.
The usage.
Gets or sets the blip name.
The name.
Gets or sets the unused2.
The unused2.
Gets or sets the unused3.
The unused3.
Gets or sets the blip record.
The blip record.
Gets or sets any remaining data in this record.
The remaining data.
A complex property differs from a simple property in that the data can not fit inside a 32 bit
integer. See the specification for more detailed information regarding exactly what is
stored here.
@author Glen Stampoultzis
Create a complex property using the property id and a byte array containing the complex
data value.
The id consists of the property number, a flag indicating whether this is a blip id and a flag
indicating that this is a complex property.
The value of this property.
Create a complex property using the property number, a flag to indicate whether this is a
blip reference and the complex property data.
The property number.
Whether this is a blip id. Should be false.
The value of this complex property.
Serializes the simple part of this property. ie the first 6 bytes.
Serializes the complex part of this property
The data array to Serialize to
The offset within data to start serializing to.
The number of bytes Serialized.
Determine whether this property is equal to another property.
The object to compare to.
True if the objects are equal.
Serves as a hash function for a particular type.
A hash code for the current .
Returns a that represents the current .
A that represents the current .
Gets the complex data.
The complex data.
Caclulates the number of bytes required to Serialize this property.
Number of bytes
A list of the most recently used colours for the drawings contained in
this document.
@author Glen Stampoultzis (glens at apache.org)
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into data
May be null since this is not a container record.
The number of bytes Read from the byte array.
This method Serializes this escher record into a byte array
The offset into data
to start writing the record data to.
The byte array to Serialize to.
The number of bytes written.
Returns a that represents the current .
A that represents the current .
@return a string representation of this record.
Returns the number of bytes that are required to Serialize this record.
number of bytes
Return the current record id.
the 16 bit identifer for this record.
Gets the short name for this record
The name of the record.
Gets or sets the color1.
The color1.
Gets or sets the color2.
The color2.
Gets or sets the color3.
The color3.
Gets or sets the color4.
The color4.
This record defines the drawing groups used for a particular sheet.
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into data
May be null since this is not a container record.
The number of bytes Read from the byte array.
This method Serializes this escher record into a byte array.
The offset into data to start writing the record data to.
The byte array to Serialize to.
The number of bytes written.
Returns a that represents the current .
A that represents the current .
Adds the cluster.
The dg id.
The num shaped used.
Adds the cluster.
id of the drawing group (stored in the record options)
initial value of the numShapedUsed field
if set to true if true then sort clusters by drawing group id.(
In Excel the clusters are sorted but in PPT they are not).
Returns the number of bytes that are required to Serialize this record.
Number of bytes
Return the current record id.
The 16 bit record id.
The short name for this record
Gets or sets the shape id max.
The shape id max.
Gets the Number of id clusters + 1
The num id clusters.
Gets or sets the num shapes saved.
The num shapes saved.
Gets or sets the drawings saved.
The drawings saved.
Gets or sets the max drawing group id.
The max drawing group id.
Gets or sets the file id clusters.
The file id clusters.
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.
@author Glen Stampoultzis
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into data
May be null since this is not a container record.
The number of bytes Read from the byte array.
This method Serializes this escher record into a byte array
The offset into data
to start writing the record data to.
The byte array to Serialize to.
The number of bytes written.
Returns a that represents the current .
A that represents the current .
The list of properties stored by this record.
The index.
Add a property to this record.
The prop.
Records should be sorted by property number before being stored.
Returns the number of bytes that are required to Serialize this record.
Number of bytes
Automatically recalculate the correct option
The short name for this record
Gets the size of the properties.
The list of properties stored by this record.
Generates escher records when provided the byte array containing those records.
@author Glen Stampoultzis
@author Nick Burch (nick at torchbox . com)
The escher record factory interface allows for the creation of escher
records from a pointer into a data array.
@author Glen Stampoultzis (glens at apache.org)
Create a new escher record from the data provided. Does not attempt
to Fill the contents of the record however.
The data.
The off set.
Initializes a new instance of the class.
Generates an escher record including the any children contained under that record.
An exception is thrown if the record could not be generated.
The byte array containing the records
The starting offset into the byte array
The generated escher record
Converts from a list of classes into a map that Contains the record id as the key and
the Constructor in the value part of the map. It does this by using reflection to look up
the RECORD_ID field then using reflection again to find a reference to the constructor.
The records to convert
The map containing the id/constructor pairs.
This record simply holds the number of shapes in the drawing group and the
last shape id used for this drawing group.
@author Glen Stampoultzis
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into data
May be null since this is not a container record.
The number of bytes Read from the byte array.
This method Serializes this escher record into a byte array.
The offset into data to start writing the record data to.
The byte array to Serialize to.
The number of bytes written.
Returns a that represents the current .
A that represents the current .
Increments the shape count.
Returns the number of bytes that are required to Serialize this record.
Number of bytes
Return the current record id.
The 16 bit record id.
The short name for this record
Gets or sets The number of shapes in this drawing group.
The num shapes.
Gets or sets The last shape id used in this drawing group.
The last MSOSPID.
Gets the drawing group id for this record. This is encoded in the
instance part of the option record.
The drawing group id.
@author Daniel Noll
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into
May be null since this is not a container record.
The number of bytes Read from the byte array.
Serializes the record to an existing byte array.
the offset within the byte array
the data array to Serialize to
the number of bytes written.
Decompresses the provided data, returning the inflated result.
the deflated picture data.
the inflated picture data.
Returns a that represents the current .
A that represents the current .
Returns the number of bytes that are required to Serialize this record.
Number of bytes
Gets or sets the UID.
The UID.
Gets or sets the size of the uncompressed.
The size of the uncompressed.
Gets or sets the bounds.
The bounds.
Gets or sets the size EMU.
The size EMU.
Gets or sets the size of the compressed.
The size of the compressed.
Gets a value indicating whether this instance is compressed.
true if this instance is compressed; otherwise, false.
@author Glen Stampoultzis
@version $Id: EscherBitmapBlip.java 569827 2007-08-26 15:26:29Z yegor $
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into
May be null since this is not a container record.
The number of bytes Read from the byte array.
Serializes the record to an existing byte array.
the offset within the byte array
the data array to Serialize to
the number of bytes written.
Toes the string.
Returns the number of bytes that are required to Serialize this record.
Number of bytes
Gets or sets the UID.
The UID.
Gets or sets the marker.
The marker.
Generates a property given a reference into the byte array storing that property.
@author Glen Stampoultzis
Create new properties from a byte array.
The byte array containing the property
The starting offset into the byte array
The new properties
The spgr record defines information about a shape group. Groups in escher
are simply another form of shape that you can't physically see.
@author Glen Stampoultzis (glens at apache.org)
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into data
May be null since this is not a container record.
The number of bytes Read from the byte array.
This method Serializes this escher record into a byte array
The offset into data
to start writing the record data to.
The byte array to Serialize to.
The number of bytes written.
Returns a that represents the current .
A that represents the current .
Returns the number of bytes that are required to Serialize this record.
Number of bytes
Return the current record id.
The 16 bit identifier of this shape group record.
The short name for this record
Gets or sets the starting top-left coordinate of child records.
The rect x1.
Gets or sets the starting bottom-right coordinate of child records.
The rect x2.
Gets or sets the starting top-left coordinate of child records.
The rect y1.
Gets or sets the starting bottom-right coordinate of child records.
The rect y2.
The escher client anchor specifies which rows and cells the shape is bound to as well as
the offsets within those cells. Each cell is 1024 units wide by 256 units long regardless
of the actual size of the cell. The EscherClientAnchorRecord only applies to the top-most
shapes. Shapes contained in groups are bound using the EscherChildAnchorRecords.
@author Glen Stampoultzis
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into data
May be null since this is not a container record.
The number of bytes Read from the byte array.
This method Serializes this escher record into a byte array.
The offset into data to start writing the record data to.
The byte array to Serialize to.
The number of bytes written.
Returns a that represents the current .
A that represents the current .
Returns the number of bytes that are required to Serialize this record.
Number of bytes
The record id for this record.
The short name for this record
Gets or sets the flag.
0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
Gets or sets The column number for the top-left position. 0 based.
The col1.
Gets or sets The x offset within the top-left cell. Range is from 0 to 1023.
The DX1.
Gets or sets The row number for the top-left corner of the shape.
The row1.
Gets or sets The y offset within the top-left corner of the current shape.
The dy1.
Gets or sets The column of the bottom right corner of this shape.
The col2.
Gets or sets The x offset withing the cell for the bottom-right corner of this shape.
The DX2.
Gets or sets The row number for the bottom-right corner of the current shape.
The row2.
Gets or sets The y offset withing the cell for the bottom-right corner of this shape.
The dy2.
Gets or sets the remaining data.
The remaining data.
The EscherClientDataRecord is used to store client specific data about the position of a
shape within a container.
@author Glen Stampoultzis
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into data
May be null since this is not a container record.
The number of bytes Read from the byte array.
This method Serializes this escher record into a byte array.
@param offset The offset into data to start writing the record data to.
@param data The byte array to Serialize to.
@param listener A listener to retrieve start and end callbacks. Use a NullEscherSerailizationListener to ignore these events.
@return The number of bytes written.
@see NullEscherSerializationListener
Returns the string representation of this record.
Returns the number of bytes that are required to Serialize this record.
@return Number of bytes
Returns the identifier of this record.
The short name for this record
Any data recording this record.
A color property.
@author Glen Stampoultzis (glens at apache.org)
Initializes a new instance of the class.
The property number.
Color of the RGB.
Gets the color of the RGB.
The color of the RGB.
Gets the red.
The red.
Gets the green.
The green.
Gets the blue.
The blue.
Holds data from the parent application. Most commonly used to store
text in the format of the parent application, rather than in
Escher format. We don't attempt to understand the contents, since
they will be in the parent's format, not Escher format.
@author Glen Stampoultzis (glens at apache.org)
@author Nick Burch (nick at torchbox dot com)
The data for this record not including the the 8 byte header
This method deserializes the record from a byte array.
@param data The byte array containing the escher record information
@param offset The starting offset into data.
@param recordFactory May be null since this is not a container record.
@return The number of bytes Read from the byte array.
Writes this record and any contained records to the supplied byte
the number of bytes written.
Sets the extra data (in the parent application's format) to be
contained by the record. Used when the parent application changes
the contents.
The b.
The start.
The length.
Sets the data.
The b.
Returns a that represents the current .
A that represents the current .
Returns any extra data associated with this record. In practice excel
does not seem to put anything here, but with PowerPoint this will
contain the bytes that make up a TextHeaderAtom followed by a
TextBytesAtom/TextCharsAtom
The data.
Returns the number of bytes that are required to serialize this record.
Number of bytes
The short name for this record
@author Daniel Noll
BLIP signatures as defined in the escher spec
The primary UID is only saved to disk if (blip_instance ^ blip_signature == 1)
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into
May be null since this is not a container record.
The number of bytes Read from the byte array.
Serializes the record to an existing byte array.
the offset within the byte array
the data array to Serialize to
the number of bytes written.
Decompresses the provided data, returning the inflated result.
the deflated picture data.
the inflated picture data.
Returns a that represents the current .
A that represents the current .
Returns the number of bytes that are required to Serialize this record.
Number of bytes
Gets or sets the UID.
The UID.
Gets or sets the primary UID.
The primary UID.
Gets or sets the size of the uncompressed.
The size of the uncompressed.
Gets or sets the bounds.
The bounds.
Gets or sets the size EMU.
The size EMU.
Gets or sets the size of the compressed.
The size of the compressed.
Gets or sets a value indicating whether this instance is compressed.
true if this instance is compressed; otherwise, false.
Return the blip signature
the blip signature
Provides a list of all known escher properties including the description and
type.
@author Glen Stampoultzis (glens at apache.org)
Inits the props.
Adds the prop.
The s.
The data.
Gets the data.
Name of the prop.
The type.
Gets the data.
Name of the prop.
Gets the name of the property.
The property id.
Gets the type of the property.
The property id.
The escher child achor record is used to specify the position of a shape under an
existing group. The first level of shape records use a EscherClientAnchor record instead.
@author Glen Stampoultzis
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into data
May be null since this is not a container record.
The number of bytes Read from the byte array.
This method Serializes this escher record into a byte array.
The offset into data to start writing the record data to.
The byte array to Serialize to.
The number of bytes written.
Returns a that represents the current .
A that represents the current .
Returns the number of bytes that are required to Serialize this record.
Number of bytes
The record id for the EscherChildAnchorRecord.
The short name for this record
Gets or sets offset within the parent coordinate space for the top left point.
The DX1.
Gets or sets the offset within the parent coordinate space for the top left point.
The dy1.
Gets or sets the offset within the parent coordinate space for the bottom right point.
The DX2.
Gets or sets the offset within the parent coordinate space for the bottom right point.
The dy2.
Used to dump the contents of escher records to a PrintStream.
@author Glen Stampoultzis (glens at apache.org)
Decodes the escher stream from a byte array and dumps the results to
a print stream.
The data array containing the escher records.
The starting offset within the data array.
The number of bytes to Read.
This version of dump is a translation from the open office escher dump routine.
The number of bytes to Read
An input stream to Read from.
Returns a property name given a property id. This is used only by the
old escher dump routine.
The property number for the name
A descriptive name.
Returns the blip description given a blip id.
blip id
A description.
Straight conversion from OO. Converts a type of float.
The N32.
Dumps out a hex value by Reading from a input stream.
How many bytes this hex value consists of.
The stream to Read the hex value from.
Dumps the specified record size.
Size of the record.
The data.
Escher array properties are the most wierd construction ever invented
with all sorts of special cases. I'm hopeful I've got them all.
@author Glen Stampoultzis (glens at superlinksoftware.com)
The size of the header that goes at the
start of the array, before the data
Normally, the size recorded in the simple data (for the complex
data) includes the size of the header.
There are a few cases when it doesn't though...
When Reading a property from data stream remeber if the complex part is empty and Set this flag.
Gets the element.
The index.
Sets the element.
The index.
The element.
Retrieves the string representation for this property.
We have this method because the way in which arrays in escher works
is screwed for seemly arbitary reasons. While most properties are
fairly consistent and have a predictable array size, escher arrays
have special cases.
The data array containing the escher array information
The offset into the array to start Reading from.
the number of bytes used by this complex property.
Serializes the simple part of this property. ie the first 6 bytes.
Needs special code to handle the case when the size doesn't
include the size of the header block
Sometimes the element size is stored as a negative number. We
negate it and shift it to Get the real value.
The size of elements.
Represents a bool property. The actual utility of this property is in doubt because many
of the properties marked as bool seem to actually contain special values. In other words
they're not true bools.
@author Glen Stampoultzis
Create an instance of an escher bool property.
The property number (or id)
The 32 bit value of this bool property
Whether this bool property is true
true if this instance is true; otherwise, false.
Whether this bool property is false
true if this instance is false; otherwise, false.
Escher container records store other escher records as children.
The container records themselves never store any information beyond
the standard header used by all escher records. This one record is
used to represent many different types of records.
@author Glen Stampoultzis
The contract of this method is to deSerialize an escher record including
it's children.
The byte array containing the Serialized escher
records.
The offset into the byte array.
A factory for creating new escher records
The number of bytes written.
Serializes to an existing byte array without serialization listener.
This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
the offset within the data byte array.
the data array to Serialize to.
The number of bytes written.
Do any of our (top level) children have the
given recordId?
The record id.
true if [has child of type] [the specified record id]; otherwise, false.
The display methods allows escher variables to print the record names
according to their hierarchy.
The current indent level.
Adds the child record.
The record.
Returns a that represents the current .
A that represents the current .
Toes the string.
The indent.
Gets the child by id.
The record id.
Recursively find records with the specified record ID
list to store found records
Subclasses should effeciently return the number of bytes required to
Serialize the record.
number of bytes
Returns a list of all the child (escher) records
of the container.
Returns all of our children which are also
EscherContainers (may be 0, 1, or vary rarely
2 or 3)
The child containers.
Subclasses should return the short name for this escher record.
This record is used whenever a escher record is encountered that
we do not explicitly support.
@author Glen Stampoultzis (glens at apache.org)
The data for this record not including the the 8 byte header
This method deSerializes the record from a byte array.
The byte array containing the escher record information
The starting offset into data
May be null since this is not a container record.
The number of bytes Read from the byte array.
Writes this record and any contained records to the supplied byte
array.
the number of bytes written.
Returns a that represents the current .
A that represents the current .
Adds the child record.
The child record.
Gets the data.
The data.
Returns the number of bytes that are required to Serialize this record.
Number of bytes
Returns the children of this record. By default this will
be an empty list. EscherCotainerRecord is the only record
that may contain children.
The short name for this record