Package loci.poi.ddf
Class EscherBSERecord
java.lang.Object
loci.poi.ddf.EscherRecord
loci.poi.ddf.EscherBSERecord
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 Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final bytestatic final bytestatic final bytestatic final bytestatic final bytestatic final bytestatic final bytestatic final bytestatic final Stringstatic final short -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintfillFields(byte[] data, int offset, EscherRecordFactory recordFactory) This method deserializes the record from a byte array.getBlipType(byte b) Retrieve the string representation given a blip id.byteThe expected blip type under MacOS (failure to match this blip type will result in Excel converting to this format).byteThe expected blip type under windows (failure to match this blip type will result in Excel converting to this format).bytegetName()The length in characters of the blip name.intFile offset in the delay stream.The short name for this recordintReturns the number of bytes that are required to serialize this record.intgetRef()The reference count of this blip.byte[]Any remaining data in this record.intgetSize()Blip size in stream.shortgetTag()unusedbyte[]getUid()16 byte MD4 checksum.bytebytebytegetUsage()Defines the way this blip is used.intserialize(int offset, byte[] data, EscherSerializationListener listener) This method serializes this escher record into a byte array.voidsetBlipRecord(EscherBlipRecord field_12_blipRecord) voidsetBlipTypeMacOS(byte blipTypeMacOS) Set the expected MacOS blip typevoidsetBlipTypeWin32(byte blipTypeWin32) Set the expected win32 blip typevoidsetName(byte name) The length in characters of the blip name.voidsetOffset(int offset) File offset in the delay stream.voidsetRef(int ref) The reference count of this blip.voidsetRemainingData(byte[] remainingData) Any remaining data in this record.voidsetSize(int size) Blip size in stream.voidsetTag(short tag) unusedvoidsetUid(byte[] uid) 16 byte MD4 checksum.voidsetUnused2(byte unused2) voidsetUnused3(byte unused3) voidsetUsage(byte usage) Defines the way this blip is used.toString()Calculate the string representation of this objectMethods inherited from class loci.poi.ddf.EscherRecord
clone, display, fillFields, getChild, getChildRecords, getInstance, getOptions, getRecordId, isContainerRecord, readHeader, serialize, serialize, setChildRecords, setOptions, setRecordId
-
Field Details
-
RECORD_ID
public static final short RECORD_ID- See Also:
-
RECORD_DESCRIPTION
- See Also:
-
BT_ERROR
public static final byte BT_ERROR- See Also:
-
BT_UNKNOWN
public static final byte BT_UNKNOWN- See Also:
-
BT_EMF
public static final byte BT_EMF- See Also:
-
BT_WMF
public static final byte BT_WMF- See Also:
-
BT_PICT
public static final byte BT_PICT- See Also:
-
BT_JPEG
public static final byte BT_JPEG- See Also:
-
BT_PNG
public static final byte BT_PNG- See Also:
-
BT_DIB
public static final byte BT_DIB- See Also:
-
-
Constructor Details
-
EscherBSERecord
public EscherBSERecord()
-
-
Method Details
-
fillFields
This method deserializes the record from a byte array.- Specified by:
fillFieldsin classEscherRecord- Parameters:
data- The byte array containing the escher record informationoffset- The starting offset intodata.recordFactory- May be null since this is not a container record.- Returns:
- The number of bytes read from the byte array.
-
serialize
This method serializes this escher record into a byte array.- Specified by:
serializein classEscherRecord- Parameters:
offset- The offset intodatato start writing the record data to.data- The byte array to serialize to.listener- A listener to retrieve start and end callbacks. Use aNullEscherSerailizationListenerto ignore these events.- Returns:
- The number of bytes written.
- See Also:
-
getRecordSize
public int getRecordSize()Returns the number of bytes that are required to serialize this record.- Specified by:
getRecordSizein classEscherRecord- Returns:
- Number of bytes
-
getRecordName
The short name for this record- Specified by:
getRecordNamein classEscherRecord
-
getBlipTypeWin32
public byte getBlipTypeWin32()The expected blip type under windows (failure to match this blip type will result in Excel converting to this format). -
setBlipTypeWin32
public void setBlipTypeWin32(byte blipTypeWin32) Set the expected win32 blip type -
getBlipTypeMacOS
public byte getBlipTypeMacOS()The expected blip type under MacOS (failure to match this blip type will result in Excel converting to this format). -
setBlipTypeMacOS
public void setBlipTypeMacOS(byte blipTypeMacOS) Set the expected MacOS blip type -
getUid
public byte[] getUid()16 byte MD4 checksum. -
setUid
public void setUid(byte[] uid) 16 byte MD4 checksum. -
getTag
public short getTag()unused -
setTag
public void setTag(short tag) unused -
getSize
public int getSize()Blip size in stream. -
setSize
public void setSize(int size) Blip size in stream. -
getRef
public int getRef()The reference count of this blip. -
setRef
public void setRef(int ref) The reference count of this blip. -
getOffset
public int getOffset()File offset in the delay stream. -
setOffset
public void setOffset(int offset) File offset in the delay stream. -
getUsage
public byte getUsage()Defines the way this blip is used. -
setUsage
public void setUsage(byte usage) Defines the way this blip is used. -
getName
public byte getName()The length in characters of the blip name. -
setName
public void setName(byte name) The length in characters of the blip name. -
getUnused2
public byte getUnused2() -
setUnused2
public void setUnused2(byte unused2) -
getUnused3
public byte getUnused3() -
setUnused3
public void setUnused3(byte unused3) -
getBlipRecord
-
setBlipRecord
-
getRemainingData
public byte[] getRemainingData()Any remaining data in this record. -
setRemainingData
public void setRemainingData(byte[] remainingData) Any remaining data in this record. -
toString
Calculate the string representation of this object -
getBlipType
Retrieve the string representation given a blip id.
-