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

public Class EscherChildAnchorRecord

extends EscherRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndian
The escher child anchor record is used to specify the position of a shape under an existing group.

The first level of shape records use a EscherClientAnchorRecord instead.

See Also
EscherClientAnchorRecord

Field Summary

Modifier and TypeField and Description
private int
field_1_dx1

private int
field_2_dy1

private int
field_3_dx2

private int
field_4_dy2

public static final short
RECORD_ID

Constructor Summary

AccessConstructor and Description
public
EscherChildAnchorRecord()

public
EscherChildAnchorRecord(EscherChildAnchorRecord other)

Method Summary

Modifier and TypeMethod and Description
public EscherChildAnchorRecord
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 int

Returns:

the x offset of the top left point
getDx1()

Retrieves offset within the parent coordinate space for the top left point.

public int

Returns:

the x offset of the bottom right point
getDx2()

Retrieves offset within the parent coordinate space for the bottom right point.

public int

Returns:

the y offset of the top left point
getDy1()

Gets offset within the parent coordinate space for the top left point.

public int

Returns:

the y offset of the bottom right point
getDy2()

Gets the offset within the parent coordinate space for the bottom right point.

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
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
setDx1(int
the x offset of the top left point
field_1_dx1)

Sets offset within the parent coordinate space for the top left point.

public void
setDx2(int
the x offset of the bottom right point
field_3_dx2)

Sets offset within the parent coordinate space for the bottom right point.

public void
setDy1(int
the y offset of the top left point
field_2_dy1)

Sets offset within the parent coordinate space for the top left point.

public void
setDy2(int
the y offset of the bottom right point
field_4_dy2)

Sets the offset within the parent coordinate space for the bottom right point.

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

Field Detail

field_1_dx1back to summary
private int field_1_dx1
field_2_dy1back to summary
private int field_2_dy1
field_3_dx2back to summary
private int field_3_dx2
field_4_dy2back to summary
private int field_4_dy2
RECORD_IDback to summary
public static final short RECORD_ID

Constructor Detail

EscherChildAnchorRecordback to summary
public EscherChildAnchorRecord()
EscherChildAnchorRecordback to summary
public EscherChildAnchorRecord(EscherChildAnchorRecord other)

Method Detail

copyback to summary
public EscherChildAnchorRecord copy()

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

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

Returns:EscherChildAnchorRecord

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
getDx1back to summary
public int getDx1()

Retrieves offset within the parent coordinate space for the top left point.

Returns:int

the x offset of the top left point

getDx2back to summary
public int getDx2()

Retrieves offset within the parent coordinate space for the bottom right point.

Returns:int

the x offset of the bottom right point

getDy1back to summary
public int getDy1()

Gets offset within the parent coordinate space for the top left point.

Returns:int

the y offset of the top left point

getDy2back to summary
public int getDy2()

Gets the offset within the parent coordinate space for the bottom right point.

Returns:int

the y offset of the bottom right point

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
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
setDx1back to summary
public void setDx1(int field_1_dx1)

Sets offset within the parent coordinate space for the top left point.

Parameters
field_1_dx1:int

the x offset of the top left point

setDx2back to summary
public void setDx2(int field_3_dx2)

Sets offset within the parent coordinate space for the bottom right point.

Parameters
field_3_dx2:int

the x offset of the bottom right point

setDy1back to summary
public void setDy1(int field_2_dy1)

Sets offset within the parent coordinate space for the top left point.

Parameters
field_2_dy1:int

the y offset of the top left point

setDy2back to summary
public void setDy2(int field_4_dy2)

Sets the offset within the parent coordinate space for the bottom right point.

Parameters
field_4_dy2:int

the y offset of the bottom right point