FileDocCategorySizeDatePackage
EscherSimpleProperty.javaAPI DocApache Poi 3.0.14021Mon Jan 01 12:39:40 GMT 2007org.apache.poi.ddf

EscherSimpleProperty

public class EscherSimpleProperty extends EscherProperty
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.
author
Glen Stampoultzis (glens at apache.org)

Fields Summary
protected int
propertyValue
Constructors Summary
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.

        super( id );
        this.propertyValue = propertyValue;
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.

        super( propertyNumber, isComplex, isBlipId );
        this.propertyValue = propertyValue;
Methods Summary
public booleanequals(java.lang.Object o)
Returns true if one escher property is equal to another.

        if ( this == o ) return true;
        if ( !( o instanceof EscherSimpleProperty ) ) return false;

        final EscherSimpleProperty escherSimpleProperty = (EscherSimpleProperty) o;

        if ( propertyValue != escherSimpleProperty.propertyValue ) return false;
        if ( getId() != escherSimpleProperty.getId() ) return false;

        return true;
public intgetPropertyValue()

return
Return the 32 bit value of this property.

        return propertyValue;
public inthashCode()
Returns a hashcode so that this object can be stored in collections that require the use of such things.

        return propertyValue;
public intserializeComplexPart(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.

        return 0;
public intserializeSimplePart(byte[] data, int offset)
Serialize the simple part of the escher record.

return
the number of bytes serialized.

        LittleEndian.putShort(data, offset, getId());
        LittleEndian.putInt(data, offset + 2, propertyValue);
        return 6;
public java.lang.StringtoString()

return
the string representation of this property.

        return "propNum: " + getPropertyNumber()
                + ", RAW: 0x" + HexDump.toHex( getId() )
                + ", propName: " + EscherProperties.getPropertyName( getPropertyNumber() )
                + ", complex: " + isComplex()
                + ", blipId: " + isBlipId()
                + ", value: " + propertyValue + " (0x" + HexDump.toHex(propertyValue) + ")";