Package org.apache.poi.ddf
Class EscherComplexProperty
java.lang.Object
org.apache.poi.ddf.EscherProperty
org.apache.poi.ddf.EscherComplexProperty
- Direct Known Subclasses:
EscherArrayProperty
A complex property differs from a simple property in that the data can not fit inside a 32 bit
integer. See the specification for more detailed information regarding exactly what is
stored here.
-
Constructor Summary
ConstructorsConstructorDescriptionEscherComplexProperty
(short propertyNumber, boolean isBlipId, byte[] complexData) Create a complex property using the property number, a flag to indicate whether this is a blip reference and the complex property data.EscherComplexProperty
(short id, byte[] complexData) Create a complex property using the property id and a byte array containing the complex data value. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determine whether this property is equal to another property.byte[]
Get the complex data value.int
Calculates the number of bytes required to serialize this property.int
hashCode()
int
serializeComplexPart
(byte[] data, int pos) Serializes the complex part of this propertyint
serializeSimplePart
(byte[] data, int pos) Serializes the simple part of this property.protected void
setComplexData
(byte[] _complexData) toString()
Retrieves the string representation for this property.Methods inherited from class org.apache.poi.ddf.EscherProperty
getId, getName, getPropertyNumber, isBlipId, isComplex
-
Constructor Details
-
EscherComplexProperty
public EscherComplexProperty(short id, byte[] complexData) Create a complex property using the property id and a byte array containing the complex data value.- Parameters:
id
- The id consists of the property number, a flag indicating whether this is a blip id and a flag indicating that this is a complex property.complexData
- The value of this property.
-
EscherComplexProperty
public EscherComplexProperty(short propertyNumber, boolean isBlipId, byte[] complexData) Create a complex property using the property number, a flag to indicate whether this is a blip reference and the complex property data.- Parameters:
propertyNumber
- The property numberisBlipId
- Whether this is a blip id. Should be false.complexData
- The value of this complex property.
-
-
Method Details
-
serializeSimplePart
public int serializeSimplePart(byte[] data, int pos) Serializes the simple part of this property. i.e. the first 6 bytes.- Specified by:
serializeSimplePart
in classEscherProperty
- Parameters:
data
- the buffer to write topos
- the starting position- Returns:
- the length of the part
-
serializeComplexPart
public int serializeComplexPart(byte[] data, int pos) Serializes the complex part of this property- Specified by:
serializeComplexPart
in classEscherProperty
- Parameters:
data
- The data array to serialize topos
- The offset within data to start serializing to.- Returns:
- The number of bytes serialized.
-
getComplexData
public byte[] getComplexData()Get the complex data value.- Returns:
- the complex bytes
-
setComplexData
protected void setComplexData(byte[] _complexData) -
equals
Determine whether this property is equal to another property. -
getPropertySize
public int getPropertySize()Calculates the number of bytes required to serialize this property.- Overrides:
getPropertySize
in classEscherProperty
- Returns:
- Number of bytes
-
hashCode
public int hashCode() -
toString
Retrieves the string representation for this property.- Specified by:
toString
in classEscherProperty
-
toXml
- Overrides:
toXml
in classEscherProperty
-