|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.ddf.EscherRecord org.apache.poi.ddf.EscherBSERecord
public final class 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.
EscherBlipRecord
Field Summary | |
---|---|
static byte |
BT_DIB
|
static byte |
BT_EMF
|
static byte |
BT_ERROR
|
static byte |
BT_JPEG
|
static byte |
BT_PICT
|
static byte |
BT_PNG
|
static byte |
BT_UNKNOWN
|
static byte |
BT_WMF
|
static java.lang.String |
RECORD_DESCRIPTION
|
static short |
RECORD_ID
|
Constructor Summary | |
---|---|
EscherBSERecord()
|
Method Summary | |
---|---|
int |
fillFields(byte[] data,
int offset,
EscherRecordFactory recordFactory)
The contract of this method is to deserialize an escher record including it's children. |
EscherBlipRecord |
getBlipRecord()
|
static java.lang.String |
getBlipType(byte b)
Retrieve the string representation given a blip id. |
byte |
getBlipTypeMacOS()
The expected blip type under MacOS (failure to match this blip type will result in Excel converting to this format). |
byte |
getBlipTypeWin32()
The expected blip type under windows (failure to match this blip type will result in Excel converting to this format). |
byte |
getName()
The length in characters of the blip name. |
int |
getOffset()
File offset in the delay stream. |
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 |
getRef()
The reference count of this blip. |
byte[] |
getRemainingData()
Any remaining data in this record. |
int |
getSize()
Blip size in stream. |
short |
getTag()
unused |
byte[] |
getUid()
16 byte MD4 checksum. |
byte |
getUnused2()
|
byte |
getUnused3()
|
byte |
getUsage()
Defines the way this blip is used. |
int |
serialize(int offset,
byte[] data,
EscherSerializationListener listener)
Serializes the record to an existing byte array. |
void |
setBlipRecord(EscherBlipRecord blipRecord)
|
void |
setBlipTypeMacOS(byte blipTypeMacOS)
Set the expected MacOS blip type |
void |
setBlipTypeWin32(byte blipTypeWin32)
Set the expected win32 blip type |
void |
setName(byte name)
The length in characters of the blip name. |
void |
setOffset(int offset)
File offset in the delay stream. |
void |
setRef(int ref)
The reference count of this blip. |
void |
setRemainingData(byte[] remainingData)
Any remaining data in this record. |
void |
setSize(int size)
Blip size in stream. |
void |
setTag(short tag)
unused |
void |
setUid(byte[] uid)
16 byte MD4 checksum. |
void |
setUnused2(byte unused2)
|
void |
setUnused3(byte unused3)
|
void |
setUsage(byte usage)
Defines the way this blip is used. |
java.lang.String |
toString()
|
Methods inherited from class org.apache.poi.ddf.EscherRecord |
---|
clone, display, fillFields, getChild, getChildRecords, getInstance, getOptions, getRecordId, isContainerRecord, readHeader, serialize, serialize, setChildRecords, setOptions, setRecordId |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final short RECORD_ID
public static final java.lang.String RECORD_DESCRIPTION
public static final byte BT_ERROR
public static final byte BT_UNKNOWN
public static final byte BT_EMF
public static final byte BT_WMF
public static final byte BT_PICT
public static final byte BT_JPEG
public static final byte BT_PNG
public static final byte BT_DIB
Constructor Detail |
---|
public EscherBSERecord()
Method Detail |
---|
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 java.lang.String getRecordName()
EscherRecord
getRecordName
in class EscherRecord
public byte getBlipTypeWin32()
public void setBlipTypeWin32(byte blipTypeWin32)
public byte getBlipTypeMacOS()
public void setBlipTypeMacOS(byte blipTypeMacOS)
public byte[] getUid()
public void setUid(byte[] uid)
public short getTag()
public void setTag(short tag)
public int getSize()
public void setSize(int size)
public int getRef()
public void setRef(int ref)
public int getOffset()
public void setOffset(int offset)
public byte getUsage()
public void setUsage(byte usage)
public byte getName()
public void setName(byte name)
public byte getUnused2()
public void setUnused2(byte unused2)
public byte getUnused3()
public void setUnused3(byte unused3)
public EscherBlipRecord getBlipRecord()
public void setBlipRecord(EscherBlipRecord blipRecord)
public byte[] getRemainingData()
public void setRemainingData(byte[] remainingData)
public java.lang.String toString()
toString
in class java.lang.Object
public static java.lang.String getBlipType(byte b)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |