## Uses of Class
org.apache.poi.ddf.EscherRecord

- Packages that use EscherRecord
  Package | Description
  --- | ---
  org.apache.poi.ddf | This package contains classes for decoding the Microsoft Office Drawing format otherwise known as escher henceforth known in POI as the Dreadful Drawing Format.
  org.apache.poi.hpbf.model |
  org.apache.poi.hslf.dev |
  org.apache.poi.hslf.record |
  org.apache.poi.hslf.usermodel |
  org.apache.poi.hssf.model | Provides low level API structures for reading, writing, modifying XLS files.
  org.apache.poi.hssf.record | Record package contains class representations for XLS binary strutures.
  org.apache.poi.hssf.usermodel | The usermodel package maps HSSF low level structures to familiar workbook/sheet model
  org.apache.poi.hwpf.model |

- - ### Uses of EscherRecord in org.apache.poi.ddf

    Subclasses of EscherRecord in org.apache.poi.ddf
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractEscherOptRecord` Common abstract class for `EscherOptRecord` and `EscherTertiaryOptRecord`
    `class` | `EscherBitmapBlip`
    `class` | `EscherBlipRecord`
    `class` | `EscherBSERecord` The BSE record is related closely to the `EscherBlipRecord` and stores extra information about the blip.
    `class` | `EscherChildAnchorRecord` The escher child achor record is used to specify the position of a shape under an existing group.
    `class` | `EscherClientAnchorRecord` The escher client anchor specifies which rows and cells the shape is bound to as well as the offsets within those cells.
    `class` | `EscherClientDataRecord` The EscherClientDataRecord is used to store client specific data about the position of a shape within a container.
    `class` | `EscherContainerRecord` Escher container records store other escher records as children.
    `class` | `EscherDggRecord` This record defines the drawing groups used for a particular sheet.
    `class` | `EscherDgRecord` This record simply holds the number of shapes in the drawing group and the last shape id used for this drawing group.
    `class` | `EscherMetafileBlip`
    `class` | `EscherOptRecord` The opt record is used to store property values for a shape.
    `class` | `EscherSpgrRecord` The spgr record defines information about a shape group.
    `class` | `EscherSplitMenuColorsRecord` A list of the most recently used colours for the drawings contained in this document.
    `class` | `EscherSpRecord` Together the the EscherOptRecord this record defines some of the basic properties of a shape.
    `class` | `EscherTertiaryOptRecord` "The OfficeArtTertiaryFOPT record specifies a table of OfficeArtRGFOPTE properties, as defined in section 2.3.1." -- [MS-ODRAW] -- v20110608; Office Drawing Binary File Format
    `class` | `EscherTextboxRecord` Holds data from the parent application.
    `class` | `UnknownEscherRecord` This record is used whenever a escher record is encountered that we do not explicitly support.

    Fields in org.apache.poi.ddf with type parameters of type EscherRecord
    Modifier and Type | Field and Description
    --- | ---
    `java.util.function.Supplier<? extends EscherRecord>` | EscherRecordTypes.`constructor`

    Methods in org.apache.poi.ddf with type parameters of type EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `<T extends EscherRecord> T` | EscherContainerRecord.`getChildById(short recordId)`

    Methods in org.apache.poi.ddf that return EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `EscherRecord` | EscherRecord.`clone()` Deprecated. use `copy()`
    `abstract EscherRecord` | EscherRecord.`copy()`
    `EscherRecord` | EscherRecordFactory.`createRecord(byte[] data, int offset)` Generates an escher record including any children contained under that record.
    `EscherRecord` | DefaultEscherRecordFactory.`createRecord(byte[] data, int offset)`
    `EscherRecord` | EscherContainerRecord.`getChild(int index)`
    `EscherRecord` | EscherRecord.`getChild(int index)` Returns the indexed child record.

    Methods in org.apache.poi.ddf that return types with arguments of type EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<EscherRecord>` | EscherContainerRecord.`getChildRecords()`
    `java.util.List<EscherRecord>` | UnknownEscherRecord.`getChildRecords()`
    `java.util.List<EscherRecord>` | EscherRecord.`getChildRecords()`
    `protected java.util.function.Supplier<? extends EscherRecord>` | DefaultEscherRecordFactory.`getConstructor(short options, short recordId)`
    `java.util.Iterator<EscherRecord>` | EscherContainerRecord.`iterator()`

    Methods in org.apache.poi.ddf with parameters of type EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `void` | EscherContainerRecord.`addChildBefore(EscherRecord record, int insertBeforeRecordId)` Add a child record before the record with given recordId
    `void` | EscherContainerRecord.`addChildRecord(EscherRecord record)` Append a child record
    `void` | UnknownEscherRecord.`addChildRecord(EscherRecord childRecord)`
    `void` | NullEscherSerializationListener.`afterRecordSerialize(int offset, short recordId, int size, EscherRecord record)`
    `void` | EscherSerializationListener.`afterRecordSerialize(int offset, short recordId, int size, EscherRecord record)` Fired after a record has been serialized.
    `void` | NullEscherSerializationListener.`beforeRecordSerialize(int offset, short recordId, EscherRecord record)`
    `void` | EscherSerializationListener.`beforeRecordSerialize(int offset, short recordId, EscherRecord record)` Fired before a given escher record is serialized.
    `boolean` | EscherContainerRecord.`removeChildRecord(EscherRecord toBeRemoved)` Removes the given escher record from the child list

    Method parameters in org.apache.poi.ddf with type arguments of type EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `void` | EscherContainerRecord.`getRecordsById(short recordId, java.util.List<EscherRecord> out)` Recursively find records with the specified record ID
    `void` | EscherContainerRecord.`setChildRecords(java.util.List<EscherRecord> childRecords)` replaces the internal child list with the contents of the supplied `childRecords`
    `void` | UnknownEscherRecord.`setChildRecords(java.util.List<EscherRecord> childRecords)`
    `void` | EscherRecord.`setChildRecords(java.util.List<EscherRecord> childRecords)` Sets the child records for this record.

    Constructors in org.apache.poi.ddf with parameters of type EscherRecord
    Constructor and Description
    `EscherRecord(EscherRecord other)`

  - ### Uses of EscherRecord in org.apache.poi.hpbf.model

    Methods in org.apache.poi.hpbf.model that return EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `EscherRecord[]` | EscherPart.`getEscherRecords()`

  - ### Uses of EscherRecord in org.apache.poi.hslf.dev

    Methods in org.apache.poi.hslf.dev with parameters of type EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `void` | SlideShowRecordDumper.`printEscherRecord(EscherRecord er, int indent)`

  - ### Uses of EscherRecord in org.apache.poi.hslf.record

    Subclasses of EscherRecord in org.apache.poi.hslf.record
    Modifier and Type | Class and Description
    --- | ---
    `class` | `EscherPlaceholder` An atom record that specifies whether a shape is a placeholder shape.
    `class` | `HSLFEscherClientDataRecord` An atom record that specifies whether a shape is a placeholder shape.

    Methods in org.apache.poi.hslf.record that return types with arguments of type EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `protected java.util.function.Supplier<? extends EscherRecord>` | HSLFEscherRecordFactory.`getConstructor(short options, short recordId)`
    `java.util.List<EscherRecord>` | PPDrawing.`getEscherRecords()` Get access to the underlying Escher Records
    `java.util.Iterator<EscherRecord>` | PPDrawing.`iterator()`

  - ### Uses of EscherRecord in org.apache.poi.hslf.usermodel

    Methods in org.apache.poi.hslf.usermodel with type parameters of type EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `static <T extends EscherRecord> T` | HSLFShape.`getEscherChild(EscherContainerRecord owner, EscherRecordTypes recordId)`
    `static <T extends EscherRecord> T` | HSLFShape.`getEscherChild(EscherContainerRecord owner, int recordId)` Helper method to return escher child by record ID
    `<T extends EscherRecord> T` | HSLFShape.`getEscherChild(EscherRecordTypes recordId)`
    `<T extends EscherRecord> T` | HSLFGroupShape.`getEscherChild(int recordId)`
    `<T extends EscherRecord> T` | HSLFShape.`getEscherChild(int recordId)`

  - ### Uses of EscherRecord in org.apache.poi.hssf.model

    Methods in org.apache.poi.hssf.model that return EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `static EscherRecord` | ConvertAnchor.`createAnchor(HSSFAnchor userAnchor)`

  - ### Uses of EscherRecord in org.apache.poi.hssf.record

    Methods in org.apache.poi.hssf.record that return EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `EscherRecord` | AbstractEscherHolderRecord.`findFirstWithId(short id)` Descends into all our children, returning the first EscherRecord with the given id, or null if none found
    `EscherRecord` | AbstractEscherHolderRecord.`getEscherRecord(int index)`

    Methods in org.apache.poi.hssf.record that return types with arguments of type EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<EscherRecord>` | AbstractEscherHolderRecord.`getEscherRecords()`
    `java.util.Map<EscherRecord,Record>` | EscherAggregate.`getShapeToObjMapping()`

    Methods in org.apache.poi.hssf.record with parameters of type EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | AbstractEscherHolderRecord.`addEscherRecord(EscherRecord element)`
    `void` | AbstractEscherHolderRecord.`addEscherRecord(int index, EscherRecord element)`
    `void` | EscherAggregate.`associateShapeToObjRecord(EscherRecord r, Record objRecord)` Associates an escher record to an OBJ record or a TXO record.
    `void` | EscherAggregate.`removeShapeToObjRecord(EscherRecord rec)` Remove echerRecord and associated to it Obj or TextObj record

  - ### Uses of EscherRecord in org.apache.poi.hssf.usermodel

    Methods in org.apache.poi.hssf.usermodel that return EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `protected EscherRecord` | HSSFClientAnchor.`getEscherAnchor()`
    `protected EscherRecord` | HSSFChildAnchor.`getEscherAnchor()`
    `protected abstract EscherRecord` | HSSFAnchor.`getEscherAnchor()`

  - ### Uses of EscherRecord in org.apache.poi.hwpf.model

    Methods in org.apache.poi.hwpf.model that return EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `EscherRecord` | EscherRecordHolder.`findFirstWithId(short id)` Descends into all our children, returning the first EscherRecord with the given id, or null if none found

    Methods in org.apache.poi.hwpf.model that return types with arguments of type EscherRecord
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<EscherRecord>` | PICFAndOfficeArtData.`getBlipRecords()`
    `java.util.List<EscherRecord>` | EscherRecordHolder.`getEscherRecords()`

Copyright 2020 The Apache Software Foundation or its licensors, as applicable.