Package org.apache.poi.ddf
Class EscherSimpleProperty
java.lang.Object
org.apache.poi.ddf.EscherProperty
org.apache.poi.ddf.EscherSimpleProperty
- Direct Known Subclasses:
EscherBoolProperty
,EscherRGBProperty
,EscherShapePathProperty
A simple property is of fixed length and as a property number in addition
to a 32-bit value. Properties that can't be stored in only 32-bits are
stored as EscherComplexProperty objects.
-
Constructor Summary
ConstructorsConstructorDescriptionEscherSimpleProperty
(short propertyNumber, boolean isComplex, boolean isBlipId, int propertyValue) Constructs a new escher property.EscherSimpleProperty
(short id, int propertyValue) The id is distinct from the actual property number. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if one escher property is equal to another.int
int
hashCode()
Returns a hashcode so that this object can be stored in collections that require the use of such things.int
serializeComplexPart
(byte[] data, int pos) Escher properties consist of a simple fixed length part and a complex variable length part.int
serializeSimplePart
(byte[] data, int offset) Serialize the simple part of the escher record.toString()
Methods inherited from class org.apache.poi.ddf.EscherProperty
getId, getName, getPropertyNumber, getPropertySize, isBlipId, isComplex
-
Constructor Details
-
EscherSimpleProperty
public EscherSimpleProperty(short id, int propertyValue) 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 property idpropertyValue
- the property value
-
EscherSimpleProperty
public EscherSimpleProperty(short propertyNumber, boolean isComplex, boolean isBlipId, int propertyValue) Constructs a new escher property. The three parameters are combined to form a property id.- Parameters:
propertyNumber
- the property numberisComplex
- true, if its a complex propertyisBlipId
- true, if its a blippropertyValue
- the property value
-
-
Method Details
-
serializeSimplePart
public int serializeSimplePart(byte[] data, int offset) Serialize the simple part of the escher record.- Specified by:
serializeSimplePart
in classEscherProperty
- Parameters:
data
- the buffer to write tooffset
- the starting position- Returns:
- the number of bytes serialized.
-
serializeComplexPart
public 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.- Specified by:
serializeComplexPart
in classEscherProperty
- Parameters:
data
- the buffer to write topos
- the starting position- Returns:
- the length of the part
-
getPropertyValue
public int getPropertyValue()- Returns:
- Return the 32 bit value of this property.
-
equals
Returns true if one escher property is equal to another. -
hashCode
public int hashCode()Returns a hashcode so that this object can be stored in collections that require the use of such things. -
toString
- Specified by:
toString
in classEscherProperty
- Returns:
- the string representation of this property.
-
toXml
- Overrides:
toXml
in classEscherProperty
-