Package org.apache.poi.ddf
Class EscherProperty
java.lang.Object
org.apache.poi.ddf.EscherProperty
- Direct Known Subclasses:
EscherComplexProperty
,EscherSimpleProperty
This is the abstract base class for all escher properties.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionEscherProperty
(short id) The id is distinct from the actual property number.EscherProperty
(short propertyNumber, boolean isComplex, boolean isBlipId) Constructs a new escher property. -
Method Summary
Modifier and TypeMethodDescriptionshort
getId()
getName()
short
int
Most properties are just 6 bytes in length.boolean
isBlipId()
boolean
abstract int
serializeComplexPart
(byte[] data, int pos) Escher properties consist of a simple fixed length part and a complex variable length part.abstract int
serializeSimplePart
(byte[] data, int pos) Escher properties consist of a simple fixed length part and a complex variable length part.abstract String
toString()
-
Constructor Details
-
EscherProperty
public EscherProperty(short id) The id is distinct from the actual property number. The id includes the property number the blip id flag and an indicator whether the property is complex or not.- Parameters:
id
- the combined id
-
EscherProperty
public EscherProperty(short propertyNumber, boolean isComplex, boolean isBlipId) Constructs a new escher property. The three parameters are combined to form a property id.- Parameters:
propertyNumber
- the property numberisComplex
- true, if this is a complex propertyisBlipId
- true, if this property is a blip id
-
-
Method Details
-
getId
public short getId() -
getPropertyNumber
public short getPropertyNumber() -
isComplex
public boolean isComplex() -
isBlipId
public boolean isBlipId() -
getName
-
getPropertySize
public int getPropertySize()Most properties are just 6 bytes in length. Override this if we're dealing with complex properties.- Returns:
- size of this property (in bytes)
-
toXml
-
serializeSimplePart
public abstract int serializeSimplePart(byte[] data, int pos) Escher properties consist of a simple fixed length part and a complex variable length part. The fixed length part is serialized first.- Parameters:
data
- the buffer to write topos
- the starting position- Returns:
- the length of the part
-
serializeComplexPart
public abstract int serializeComplexPart(byte[] data, int pos) Escher properties consist of a simple fixed length part and a complex variable length part. The fixed length part is serialized first.- Parameters:
data
- the buffer to write topos
- the starting position- Returns:
- the length of the part
-
toString
-