Package loci.poi.ddf
Class EscherTextboxRecord
java.lang.Object
loci.poi.ddf.EscherRecord
loci.poi.ddf.EscherTextboxRecord
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), Nick Burch (nick at torchbox dot com)
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Escher records may need to be clonable in the future.intfillFields(byte[] data, int offset, EscherRecordFactory recordFactory) This method deserializes the record from a byte array.byte[]getData()Returns any extra data associated with this record.The short name for this recordintReturns the number of bytes that are required to serialize this record.intserialize(int offset, byte[] data, EscherSerializationListener listener) Writes this record and any contained records to the supplied byte array.voidsetData(byte[] b) voidsetData(byte[] b, int start, int length) Sets the extra data (in the parent application's format) to be contained by the record.toString()Methods inherited from class loci.poi.ddf.EscherRecord
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:
-
-
Constructor Details
-
EscherTextboxRecord
public EscherTextboxRecord()
-
-
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
Writes this record and any contained records to the supplied 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.
-
getData
public byte[] getData()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 -
setData
public void setData(byte[] b, int start, int length) Sets the extra data (in the parent application's format) to be contained by the record. Used when the parent application changes the contents. -
setData
public void setData(byte[] b) -
getRecordSize
public int getRecordSize()Returns the number of bytes that are required to serialize this record.- Specified by:
getRecordSizein classEscherRecord- Returns:
- Number of bytes
-
clone
Description copied from class:EscherRecordEscher records may need to be clonable in the future.- Overrides:
clonein classEscherRecord
-
getRecordName
The short name for this record- Specified by:
getRecordNamein classEscherRecord
-
toString
-