Top Description Fields Constructors Methods
org.apache.poi.ddf

public final Class EscherTextboxRecord

extends EscherRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .IOUtils, .LittleEndian, .RecordFormatException
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.

Field Summary

Modifier and TypeField and Description
private static int
DEFAULT_MAX_RECORD_LENGTH

private static int
MAX_RECORD_LENGTH

private static final byte[]
NO_BYTES

public static final short
RECORD_ID

private byte[]
thedata

The data for this record not including the 8 byte header

Constructor Summary

AccessConstructor and Description
public
EscherTextboxRecord()

public
EscherTextboxRecord(EscherTextboxRecord other)

Method Summary

Modifier and TypeMethod and Description
public EscherTextboxRecord
copy()

Implements abstract org.apache.poi.ddf.EscherRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

public int
fillFields(byte[]
The byte array containing the serialized escher records.
data, int
The offset into the byte array.
offset, EscherRecordFactory
A factory for creating new escher records.
recordFactory)

Implements abstract org.apache.poi.ddf.EscherRecord.fillFields.

The contract of this method is to deserialize an escher record including its children.

public byte[]

Returns:

the extra data
getData()

Returns any extra data associated with this record.

public Map<String, Supplier<?>>
getGenericProperties()

Overrides org.apache.poi.ddf.EscherRecord.getGenericProperties.

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public Enum<E extends Enum<E>>
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

public static int

Returns:

the max record length allowed for EscherTextboxRecord
getMaxRecordLength()

public String
getRecordName()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordName.

Subclasses should return the short name for this escher record.

public int
getRecordSize()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordSize.

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

public int
serialize(int
the offset within the byte array
offset, byte[]
the data array to serialize to
data, EscherSerializationListener
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.
listener)

Implements abstract org.apache.poi.ddf.EscherRecord.serialize.

Serializes the record to an existing byte array.

public void
setData(byte[]
the buffer which contains the data
b, int
the start position in the buffer
start, int
the length of the block
length)

Sets the extra data (in the parent application's format) to be contained by the record.

public void
setData(byte[]
the data
b)

Sets the extra data (in the parent application's format) to be contained by the record.

public static void
setMaxRecordLength(int
the max record length allowed for EscherTextboxRecord
length)

Inherited from org.apache.poi.ddf.EscherRecord:
displayfillFieldsgetChildgetChildRecordsgetGenericChildrengetInstancegetOptionsgetRecordIdgetVersionisContainerRecordreadHeaderreadInstanceserializeserializesetChildRecordssetInstancesetOptionssetRecordIdsetVersiontoStringtoXmltoXml

Field Detail

DEFAULT_MAX_RECORD_LENGTHback to summary
private static int DEFAULT_MAX_RECORD_LENGTH
MAX_RECORD_LENGTHback to summary
private static int MAX_RECORD_LENGTH
NO_BYTESback to summary
private static final byte[] NO_BYTES
RECORD_IDback to summary
public static final short RECORD_ID
thedataback to summary
private byte[] thedata

The data for this record not including the 8 byte header

Constructor Detail

EscherTextboxRecordback to summary
public EscherTextboxRecord()
EscherTextboxRecordback to summary
public EscherTextboxRecord(EscherTextboxRecord other)

Method Detail

copyback to summary
public EscherTextboxRecord copy()

Implements abstract org.apache.poi.ddf.EscherRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:EscherTextboxRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
fillFieldsback to summary
public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)

Implements abstract org.apache.poi.ddf.EscherRecord.fillFields.

Doc from org.apache.poi.ddf.EscherRecord.fillFields.

The contract of this method is to deserialize an escher record including its children.

Parameters
data:byte[]

The byte array containing the serialized escher records.

offset:int

The offset into the byte array.

recordFactory:EscherRecordFactory

A factory for creating new escher records.

Returns:int

The number of bytes written.

Annotations
@Override
getDataback to summary
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

Returns:byte[]

the extra data

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Overrides org.apache.poi.ddf.EscherRecord.getGenericProperties.

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public Enum<E extends Enum<E>> getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Annotations
@Override
getMaxRecordLengthback to summary
public static int getMaxRecordLength()
Returns:int

the max record length allowed for EscherTextboxRecord

getRecordNameback to summary
public String getRecordName()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordName.

Doc from org.apache.poi.ddf.EscherRecord.getRecordName.

Subclasses should return the short name for this escher record.

Returns:String

the short name for this escher record

Annotations
@Override
getRecordSizeback to summary
public int getRecordSize()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordSize.

Doc from org.apache.poi.ddf.EscherRecord.getRecordSize.

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

Returns:int

number of bytes

Annotations
@Override
serializeback to summary
public int serialize(int offset, byte[] data, EscherSerializationListener listener)

Implements abstract org.apache.poi.ddf.EscherRecord.serialize.

Doc from org.apache.poi.ddf.EscherRecord.serialize.

Serializes the record to an existing byte array.

Parameters
offset:int

the offset within the byte array

data:byte[]

the data array to serialize to

listener:EscherSerializationListener

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:int

the number of bytes written.

Annotations
@Override
setDataback to summary
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.

Parameters
b:byte[]

the buffer which contains the data

start:int

the start position in the buffer

length:int

the length of the block

setDataback to summary
public void setData(byte[] b)

Sets the extra data (in the parent application's format) to be contained by the record. Used when the parent application changes the contents.

Parameters
b:byte[]

the data

setMaxRecordLengthback to summary
public static void setMaxRecordLength(int length)
Parameters
length:int

the max record length allowed for EscherTextboxRecord