Top Description Fields Constructors Methods
org.apache.poi.ddf

public Class EscherSpgrRecord

extends EscherRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndian, .RecordFormatException
The spgr record defines information about a shape group. Groups in escher are simply another form of shape that you can't physically see.

Field Summary

Modifier and TypeField and Description
private int
field_1_rectX1

private int
field_2_rectY1

private int
field_3_rectX2

private int
field_4_rectY2

public static final short
RECORD_ID

Constructor Summary

AccessConstructor and Description
public
EscherSpgrRecord()

public
EscherSpgrRecord(EscherSpgrRecord other)

Method Summary

Modifier and TypeMethod and Description
public EscherSpgrRecord
copy()

Implements abstract org.apache.poi.ddf.EscherRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

public int
fillFields(byte[]
The byte array containing the serialized escher records.
data, int
The offset into the byte array.
offset, EscherRecordFactory
A factory for creating new escher records.
recordFactory)

Implements abstract org.apache.poi.ddf.EscherRecord.fillFields.

The contract of this method is to deserialize an escher record including its children.

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

Overrides org.apache.poi.ddf.EscherRecord.getGenericProperties.

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

public Enum<E extends Enum<E>>
getGenericRecordType()

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

public short
getRecordId()

Overrides org.apache.poi.ddf.EscherRecord.getRecordId.

Return the current record id.

public String
getRecordName()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordName.

Subclasses should return the short name for this escher record.

public int
getRecordSize()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordSize.

Subclasses should effeciently return the number of bytes required to serialize the record.

public int

Returns:

the top-left x coordinate
getRectX1()

The starting top-left coordinate of child records.

public int

Returns:

the bottom-right x coordinate
getRectX2()

The bottom-right x coordinate of child records.

public int

Returns:

the top-left y coordinate
getRectY1()

The top-left coordinate of child records.

public int

Returns:

the bottom-right y coordinate
getRectY2()

The bottom-right y coordinate of child records.

public int
serialize(int
the offset within the byte array
offset, byte[]
the data array to serialize to
data, EscherSerializationListener
a listener for begin and end serialization events. This is useful because the serialization is hierarchical/recursive and sometimes you need to be able break into that.
listener)

Implements abstract org.apache.poi.ddf.EscherRecord.serialize.

Serializes the record to an existing byte array.

public void
setRectX1(int
the top-left x coordinate
x1)

The top-left coordinate of child records.

public void
setRectX2(int
the bottom-right x coordinate
x2)

The bottom-right x coordinate of child records.

public void
setRectY1(int
the top-left y coordinate
y1)

The top-left y coordinate of child records.

public void
setRectY2(int
the bottom-right y coordinate
rectY2)

The bottom-right y coordinate of child records.

Inherited from org.apache.poi.ddf.EscherRecord:
displayfillFieldsgetChildgetChildRecordsgetGenericChildrengetInstancegetOptionsgetVersionisContainerRecordreadHeaderreadInstanceserializeserializesetChildRecordssetInstancesetOptionssetRecordIdsetVersiontoStringtoXmltoXml

Field Detail

field_1_rectX1back to summary
private int field_1_rectX1
field_2_rectY1back to summary
private int field_2_rectY1
field_3_rectX2back to summary
private int field_3_rectX2
field_4_rectY2back to summary
private int field_4_rectY2
RECORD_IDback to summary
public static final short RECORD_ID

Constructor Detail

EscherSpgrRecordback to summary
public EscherSpgrRecord()
EscherSpgrRecordback to summary
public EscherSpgrRecord(EscherSpgrRecord other)

Method Detail

copyback to summary
public EscherSpgrRecord copy()

Implements abstract org.apache.poi.ddf.EscherRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:EscherSpgrRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
fillFieldsback to summary
public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)

Implements abstract org.apache.poi.ddf.EscherRecord.fillFields.

Doc from org.apache.poi.ddf.EscherRecord.fillFields.

The contract of this method is to deserialize an escher record including its children.

Parameters
data:byte[]

The byte array containing the serialized escher records.

offset:int

The offset into the byte array.

recordFactory:EscherRecordFactory

A factory for creating new escher records.

Returns:int

The number of bytes written.

Annotations
@Override
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Overrides org.apache.poi.ddf.EscherRecord.getGenericProperties.

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

Annotations
@Override
getGenericRecordTypeback to summary
public Enum<E extends Enum<E>> getGenericRecordType()

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

Annotations
@Override
getRecordIdback to summary
public short getRecordId()

Overrides org.apache.poi.ddf.EscherRecord.getRecordId.

Doc from org.apache.poi.ddf.EscherRecord.getRecordId.

Return the current record id.

Returns:short

The 16 bit record id.

Annotations
@Override
getRecordNameback to summary
public String getRecordName()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordName.

Doc from org.apache.poi.ddf.EscherRecord.getRecordName.

Subclasses should return the short name for this escher record.

Returns:String

the short name for this escher record

Annotations
@Override
getRecordSizeback to summary
public int getRecordSize()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordSize.

Doc from org.apache.poi.ddf.EscherRecord.getRecordSize.

Subclasses should effeciently return the number of bytes required to serialize the record.

Returns:int

number of bytes

Annotations
@Override
getRectX1back to summary
public int getRectX1()

The starting top-left coordinate of child records.

Returns:int

the top-left x coordinate

getRectX2back to summary
public int getRectX2()

The bottom-right x coordinate of child records.

Returns:int

the bottom-right x coordinate

getRectY1back to summary
public int getRectY1()

The top-left coordinate of child records.

Returns:int

the top-left y coordinate

getRectY2back to summary
public int getRectY2()

The bottom-right y coordinate of child records.

Returns:int

the bottom-right y coordinate

serializeback to summary
public int serialize(int offset, byte[] data, EscherSerializationListener listener)

Implements abstract org.apache.poi.ddf.EscherRecord.serialize.

Doc from org.apache.poi.ddf.EscherRecord.serialize.

Serializes the record to an existing byte array.

Parameters
offset:int

the offset within the byte array

data:byte[]

the data array to serialize to

listener:EscherSerializationListener

a listener for begin and end serialization events. This is useful because the serialization is hierarchical/recursive and sometimes you need to be able break into that.

Returns:int

the number of bytes written.

Annotations
@Override
setRectX1back to summary
public void setRectX1(int x1)

The top-left coordinate of child records.

Parameters
x1:int

the top-left x coordinate

setRectX2back to summary
public void setRectX2(int x2)

The bottom-right x coordinate of child records.

Parameters
x2:int

the bottom-right x coordinate

setRectY1back to summary
public void setRectY1(int y1)

The top-left y coordinate of child records.

Parameters
y1:int

the top-left y coordinate

setRectY2back to summary
public void setRectY2(int rectY2)

The bottom-right y coordinate of child records.

Parameters
rectY2:int

the bottom-right y coordinate