Apache POI - Common 5.3.0 · org.apache.poi.ddf.EscherProperty

Modifier and Type	Field and Description
private static final int[]	FLAG_MASK
private static final String[]	FLAG_NAMES
private final short	id
pack-priv static final int	IS_BLIP
pack-priv static final int	IS_COMPLEX

Constructor Summary

Access	Constructor and Description
protected	EscherProperty(short the combined id id) The id is distinct from the actual property number.
protected	EscherProperty(short the property number propertyNumber, boolean true, if this is a complex property isComplex, boolean true, if this property is a blip id isBlipId) Constructs a new escher property.
protected	EscherProperty(EscherPropertyTypes one of the defined property types type, boolean true, if this is a complex property isComplex, boolean true, if this property is a blip id isBlipId) Constructs a new escher property.

Method Summary

Modifier and Type	Method and Description
public List<? extends GenericRecord>	getGenericChildren() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericChildren.
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public EscherPropertyTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.
public short	getId()
public String	getName()
public short	getPropertyNumber()
public int	Returns: size of this property (in bytes) getPropertySize() Most properties are just 6 bytes in length.
public boolean	isBlipId()
public boolean	isComplex()
public abstract int	Returns: the length of the part serializeComplexPart(byte[] the buffer to write to data, int the starting position pos) Escher properties consist of a simple fixed length part and a complex variable length part.
public abstract int	Returns: the length of the part serializeSimplePart(byte[] the buffer to write to data, int the starting position pos) Escher properties consist of a simple fixed length part and a complex variable length part.
public final String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public final String	toXml(String tab)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

FLAG_MASK	back to summary
private static final int[] FLAG_MASK

FLAG_NAMES	back to summary
private static final String[] FLAG_NAMES

id	back to summary
private final short id

IS_BLIP	back to summary
pack-priv static final int IS_BLIP

IS_COMPLEX	back to summary
pack-priv static final int IS_COMPLEX

Constructor Detail

EscherProperty	back to summary
protected 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:short the combined id

EscherProperty

back to summary

protected 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:short: the combined id

EscherProperty	back to summary
protected EscherProperty(short propertyNumber, boolean isComplex, boolean isBlipId) Constructs a new escher property. The three parameters are combined to form a property id. Parameters propertyNumber:short the property number isComplex:boolean true, if this is a complex property isBlipId:boolean true, if this property is a blip id

EscherProperty

back to summary

protected EscherProperty(short propertyNumber, boolean isComplex, boolean isBlipId)

Constructs a new escher property. The three parameters are combined to form a property id.

Parameters

propertyNumber:short: the property number
isComplex:boolean: true, if this is a complex property
isBlipId:boolean: true, if this property is a blip id

EscherProperty	back to summary
protected EscherProperty(EscherPropertyTypes type, boolean isComplex, boolean isBlipId) Constructs a new escher property. The three parameters are combined to form a property id. Parameters type:EscherPropertyTypes one of the defined property types isComplex:boolean true, if this is a complex property isBlipId:boolean true, if this property is a blip id

EscherProperty

back to summary

protected EscherProperty(EscherPropertyTypes type, boolean isComplex, boolean isBlipId)

Constructs a new escher property. The three parameters are combined to form a property id.

Parameters

type:EscherPropertyTypes: one of the defined property types
isComplex:boolean: true, if this is a complex property
isBlipId:boolean: true, if this property is a blip id

Method Detail

getGenericChildren	back to summary
public List<? extends GenericRecord> getGenericChildren() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericChildren. Annotations @Override

getGenericChildren

back to summary

public List<? extends GenericRecord> getGenericChildren()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericChildren.

Annotations

@Override

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType	back to summary
public EscherPropertyTypes getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Annotations @Override

getGenericRecordType

back to summary

public EscherPropertyTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Annotations

@Override

getId	back to summary
public short getId()

getName	back to summary
public String getName()

getPropertyNumber	back to summary
public short getPropertyNumber()

getPropertySize	back to summary
public int getPropertySize() Most properties are just 6 bytes in length. Override this if we're dealing with complex properties. Returns:int size of this property (in bytes)

getPropertySize

back to summary

public int getPropertySize()

Most properties are just 6 bytes in length. Override this if we're dealing with complex properties.

Returns:int: size of this property (in bytes)

isBlipId	back to summary
public boolean isBlipId()

isComplex	back to summary
public boolean isComplex()

serializeComplexPart	back to summary
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:byte[] the buffer to write to pos:int the starting position Returns:int the length of the part

serializeComplexPart

back to summary

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:byte[]: the buffer to write to
pos:int: the starting position

Returns:int

the length of the part

serializeSimplePart	back to summary
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:byte[] the buffer to write to pos:int the starting position Returns:int the length of the part

serializeSimplePart

back to summary

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:byte[]: the buffer to write to
pos:int: the starting position

Returns:int

the length of the part

toString back to summary

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

toXml	back to summary
public final String toXml(String tab)

public abstract Class EscherProperty

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail