File Doc Category Size Date Package
EscherProperty.java API Doc Apache Poi 3.0.1 2906 Mon Jan 01 12:39:40 GMT 2007 org.apache.poi.ddf

EscherProperty

java.lang.Object

public abstract class EscherProperty extends Object

This is the abstract base class for all escher properties.

see: EscherOptRecord
author: Glen Stampoultzis (glens at apache.org)

Fields Summary
protected short
id
Constructors Summary
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.
this.id = id;
public EscherProperty(short propertyNumber, boolean isComplex, boolean isBlipId)
Constructs a new escher property. The three parameters are combined to form a property id.
this.id = (short)(propertyNumber + (isComplex ? 0x8000 : 0x0) + (isBlipId ? 0x4000 : 0x0));
Methods Summary
public short getId()
return id;
public java.lang.String getName()
return EscherProperties.getPropertyName(id);
public short getPropertyNumber()
return (short) ( id & (short) 0x3FFF );
public int getPropertySize()
Most properties are just 6 bytes in length. Override this if we're dealing with complex properties.
return 6;
public boolean isBlipId()
return ( id & (short) 0x4000 ) != 0;
public boolean isComplex()
return ( id & (short) 0x8000 ) != 0;
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.
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.