Package org.apache.poi.ddf
Class EscherProperty
- java.lang.Object
-
- org.apache.poi.ddf.EscherProperty
-
- All Implemented Interfaces:
GenericRecord
- Direct Known Subclasses:
EscherComplexProperty
,EscherSimpleProperty
public abstract class EscherProperty extends java.lang.Object implements GenericRecord
This is the abstract base class for all escher properties.- See Also:
EscherOptRecord
-
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.util.List<? extends GenericRecord>
getGenericChildren()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>
getGenericProperties()
EscherPropertyTypes
getGenericRecordType()
short
getId()
java.lang.String
getName()
short
getPropertyNumber()
int
getPropertySize()
Most properties are just 6 bytes in length.boolean
isBlipId()
boolean
isComplex()
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.java.lang.String
toString()
java.lang.String
toXml(java.lang.String tab)
-
-
-
Method Detail
-
getId
public short getId()
-
getPropertyNumber
public short getPropertyNumber()
-
isComplex
public boolean isComplex()
-
isBlipId
public boolean isBlipId()
-
getName
public java.lang.String 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)
-
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
public final java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
toXml
public final java.lang.String toXml(java.lang.String tab)
-
getGenericProperties
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
- Specified by:
getGenericProperties
in interfaceGenericRecord
-
getGenericChildren
public java.util.List<? extends GenericRecord> getGenericChildren()
- Specified by:
getGenericChildren
in interfaceGenericRecord
-
getGenericRecordType
public EscherPropertyTypes getGenericRecordType()
- Specified by:
getGenericRecordType
in interfaceGenericRecord
-
-