Package loci.poi.ddf

Class EscherClientAnchorRecord

java.lang.Object
loci.poi.ddf.EscherRecord
loci.poi.ddf.EscherClientAnchorRecord

public class EscherClientAnchorRecord extends EscherRecord
The escher client anchor specifies which rows and cells the shape is bound to as well as the offsets within those cells. Each cell is 1024 units wide by 256 units long regardless of the actual size of the cell. The EscherClientAnchorRecord only applies to the top-most shapes. Shapes contained in groups are bound using the EscherChildAnchorRecords.
Author:
Glen Stampoultzis
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
    static final short
     
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
    This method deserializes the record from a byte array.
    short
    The column number for the top-left position.
    short
    The column of the bottom right corner of this shape.
    short
    The x offset within the top-left cell.
    short
    The x offset withing the cell for the bottom-right corner of this shape.
    short
    The y offset within the top-left corner of the current shape.
    short
    The y offset withing the cell for the bottom-right corner of this shape.
    short
    0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
    short
    The record id for this record.
    The short name for this record
    int
    Returns the number of bytes that are required to serialize this record.
    byte[]
    Any remaining data in the record
    short
    The row number for the top-left corner of the shape.
    short
    The row number for the bottom-right corner of the current shape.
    int
    serialize(int offset, byte[] data, EscherSerializationListener listener)
    This method serializes this escher record into a byte array.
    void
    setCol1(short field_2_col1)
    The column number for the top-left position.
    void
    setCol2(short field_6_col2)
    The column of the bottom right corner of this shape.
    void
    setDx1(short field_3_dx1)
    The x offset within the top-left cell.
    void
    setDx2(short field_7_dx2)
    The x offset withing the cell for the bottom-right corner of this shape.
    void
    setDy1(short field_5_dy1)
    The y offset within the top-left corner of the current shape.
    void
    setDy2(short field_9_dy2)
    The y offset withing the cell for the bottom-right corner of this shape.
    void
    setFlag(short field_1_flag)
    0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
    void
    setRemainingData(byte[] remainingData)
    Any remaining data in the record
    void
    setRow1(short field_4_row1)
    The row number for the top-left corner of the shape.
    void
    setRow2(short field_8_row2)
    The row number for the bottom-right corner of the current shape.
    Returns the string representation for this record.

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

    • EscherClientAnchorRecord

      public EscherClientAnchorRecord()
  • Method Details

    • fillFields

      public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
      This method deserializes the record from a byte array.
      Specified by:
      fillFields in class EscherRecord
      Parameters:
      data - The byte array containing the escher record information
      offset - The starting offset into data.
      recordFactory - May be null since this is not a container record.
      Returns:
      The number of bytes read from the byte array.
    • serialize

      public int serialize(int offset, byte[] data, EscherSerializationListener listener)
      This method serializes this escher record into a byte array.
      Specified by:
      serialize in class EscherRecord
      Parameters:
      offset - The offset into data to start writing the record data to.
      data - The byte array to serialize to.
      listener - A listener to retrieve start and end callbacks. Use a NullEscherSerailizationListener to ignore these events.
      Returns:
      The number of bytes written.
      See Also:
    • getRecordSize

      public int getRecordSize()
      Returns the number of bytes that are required to serialize this record.
      Specified by:
      getRecordSize in class EscherRecord
      Returns:
      Number of bytes
    • getRecordId

      public short getRecordId()
      The record id for this record.
      Overrides:
      getRecordId in class EscherRecord
      Returns:
      The 16 bit record id.
    • getRecordName

      public String getRecordName()
      The short name for this record
      Specified by:
      getRecordName in class EscherRecord
    • toString

      public String toString()
      Returns the string representation for this record.
      Overrides:
      toString in class Object
      Returns:
      A string
    • getFlag

      public short getFlag()
      0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
    • setFlag

      public void setFlag(short field_1_flag)
      0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
    • getCol1

      public short getCol1()
      The column number for the top-left position. 0 based.
    • setCol1

      public void setCol1(short field_2_col1)
      The column number for the top-left position. 0 based.
    • getDx1

      public short getDx1()
      The x offset within the top-left cell. Range is from 0 to 1023.
    • setDx1

      public void setDx1(short field_3_dx1)
      The x offset within the top-left cell. Range is from 0 to 1023.
    • getRow1

      public short getRow1()
      The row number for the top-left corner of the shape.
    • setRow1

      public void setRow1(short field_4_row1)
      The row number for the top-left corner of the shape.
    • getDy1

      public short getDy1()
      The y offset within the top-left corner of the current shape.
    • setDy1

      public void setDy1(short field_5_dy1)
      The y offset within the top-left corner of the current shape.
    • getCol2

      public short getCol2()
      The column of the bottom right corner of this shape.
    • setCol2

      public void setCol2(short field_6_col2)
      The column of the bottom right corner of this shape.
    • getDx2

      public short getDx2()
      The x offset withing the cell for the bottom-right corner of this shape.
    • setDx2

      public void setDx2(short field_7_dx2)
      The x offset withing the cell for the bottom-right corner of this shape.
    • getRow2

      public short getRow2()
      The row number for the bottom-right corner of the current shape.
    • setRow2

      public void setRow2(short field_8_row2)
      The row number for the bottom-right corner of the current shape.
    • getDy2

      public short getDy2()
      The y offset withing the cell for the bottom-right corner of this shape.
    • setDy2

      public void setDy2(short field_9_dy2)
      The y offset withing the cell for the bottom-right corner of this shape.
    • getRemainingData

      public byte[] getRemainingData()
      Any remaining data in the record
    • setRemainingData

      public void setRemainingData(byte[] remainingData)
      Any remaining data in the record