org.apache.poi.ddf
Class EscherBlipRecord

java.lang.Object
  org.apache.poi.ddf.EscherRecord
      org.apache.poi.ddf.EscherBlipRecord

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

EscherBitmapBlip, EscherMetafileBlip, EscherPictBlip

public class EscherBlipRecord
extends EscherRecord

RECORD_ID_START

public static final short RECORD_ID_START

See Also:

Constant Field Values

RECORD_ID_END

public static final short RECORD_ID_END

See Also:

Constant Field Values

RECORD_DESCRIPTION

public static final java.lang.String RECORD_DESCRIPTION

See Also:

Constant Field Values

EscherBlipRecord

public EscherBlipRecord()

fillFields

public int fillFields(byte[] data,
                      int offset,
                      EscherRecordFactory recordFactory)

Description copied from class: EscherRecord

The contract of this method is to deserialize an escher record including it's children.

Specified by:

fillFields in class EscherRecord

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

public int serialize(int offset,
                     byte[] data,
                     EscherSerializationListener listener)

Description copied from class: EscherRecord

Serializes the record to an existing byte array.

Specified by:

serialize in class EscherRecord

Parameters:

offset - the offset within the byte array

data - the data array to serialize to

listener - 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()

Description copied from class: EscherRecord

Subclasses should effeciently return the number of bytes required to serialize the record.

Specified by:

getRecordSize in class EscherRecord

Returns:

number of bytes

getRecordName

public java.lang.String getRecordName()

Description copied from class: EscherRecord

Subclasses should return the short name for this escher record.

Specified by:

getRecordName in class EscherRecord

Returns:

the short name for this escher record

getPicturedata

public byte[] getPicturedata()

Gets the picture data bytes

Returns:

the picture data

setPictureData

public void setPictureData(byte[] pictureData)

Sets the picture data bytes

Parameters:

pictureData - the picture data

setPictureData

public void setPictureData(byte[] pictureData,
                           int offset,
                           int length)

Sets the picture data bytes

Parameters:

pictureData - the picture data

offset - the offset into the picture data

length - the amount of bytes to be used

getAttributeMap

protected java.lang.Object[][] getAttributeMap()

Description copied from class: EscherRecord

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 }, ... } .

Null values won't be printed.

The attributes record, version, instance, options must not be returned.

Specified by:

getAttributeMap in class EscherRecord

Returns:

the attribute map