| 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 | usermodel package maps HSSF low level strutures to familiar workbook/sheet model | 
| org.apache.poi.hwpf.model | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | AbstractEscherOptRecordCommon abstract class for  EscherOptRecordandEscherTertiaryOptRecord | 
| class  | EscherBitmapBlip | 
| class  | EscherBlipRecord | 
| class  | EscherBSERecordThe BSE record is related closely to the  EscherBlipRecordand stores
 extra information about the blip. | 
| class  | EscherChildAnchorRecordThe escher child achor record is used to specify the position of a shape under an
 existing group. | 
| class  | EscherClientAnchorRecordThe escher client anchor specifies which rows and cells the shape is bound to as well as
 the offsets within those cells. | 
| class  | EscherClientDataRecordThe EscherClientDataRecord is used to store client specific data about the position of a
 shape within a container. | 
| class  | EscherContainerRecordEscher container records store other escher records as children. | 
| class  | EscherDggRecordThis record defines the drawing groups used for a particular sheet. | 
| class  | EscherDgRecordThis record simply holds the number of shapes in the drawing group and the
 last shape id used for this drawing group. | 
| class  | EscherMetafileBlip | 
| class  | EscherOptRecordThe opt record is used to store property values for a shape. | 
| class  | EscherPictBlip | 
| class  | EscherSpgrRecordThe spgr record defines information about a shape group. | 
| class  | EscherSplitMenuColorsRecordA list of the most recently used colours for the drawings contained in
 this document. | 
| class  | EscherSpRecordTogether 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  | EscherTextboxRecordHolds data from the parent application. | 
| class  | UnknownEscherRecordThis record is used whenever a escher record is encountered that
 we do not explicitly support. | 
| Modifier and Type | Method and Description | 
|---|---|
| <T extends EscherRecord> | EscherContainerRecord. getChildById(short recordId) | 
| Modifier and Type | Method and Description | 
|---|---|
| EscherRecord | EscherRecord. clone()Escher records may need to be clonable in the future. | 
| 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. | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.List<EscherRecord> | EscherContainerRecord. getChildRecords() | 
| java.util.List<EscherRecord> | UnknownEscherRecord. getChildRecords() | 
| java.util.List<EscherRecord> | EscherRecord. getChildRecords() | 
| java.util.Iterator<EscherRecord> | EscherContainerRecord. iterator() | 
| protected static java.util.Map<java.lang.Short,java.lang.reflect.Constructor<? extends EscherRecord>> | DefaultEscherRecordFactory. recordsToMap(java.lang.Class<?>[] recClasses)Converts from a list of classes into a map that contains the record id as the key and
 the Constructor in the value part of the map. | 
| 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 | 
| 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. | 
| Modifier and Type | Method and Description | 
|---|---|
| EscherRecord[] | EscherPart. getEscherRecords() | 
| Modifier and Type | Method and Description | 
|---|---|
| void | SlideShowRecordDumper. printEscherRecord(EscherRecord er,
                 int indent) | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | EscherPlaceholderAn atom record that specifies whether a shape is a placeholder shape. | 
| class  | HSLFEscherClientDataRecordAn atom record that specifies whether a shape is a placeholder shape. | 
| Modifier and Type | Method and Description | 
|---|---|
| EscherRecord | HSLFEscherRecordFactory. createRecord(byte[] data,
            int offset) | 
| protected EscherRecord | PPDrawing. findFirstEscherRecordOfType(RecordTypes type,
                           EscherContainerRecord parent) | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.List<EscherRecord> | PPDrawing. getEscherRecords()Get access to the underlying Escher Records | 
| Modifier and Type | Method and Description | 
|---|---|
| static <T extends EscherRecord> | HSLFShape. getEscherChild(EscherContainerRecord owner,
              int recordId)Helper method to return escher child by record ID | 
| static <T extends EscherRecord> | HSLFShape. getEscherChild(EscherContainerRecord owner,
              RecordTypes recordId) | 
| <T extends EscherRecord> | HSLFGroupShape. getEscherChild(int recordId) | 
| <T extends EscherRecord> | HSLFShape. getEscherChild(int recordId) | 
| <T extends EscherRecord> | HSLFShape. getEscherChild(RecordTypes recordId) | 
| Modifier and Type | Method and Description | 
|---|---|
| static EscherRecord | ConvertAnchor. createAnchor(HSSFAnchor userAnchor) | 
| 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) | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.List<EscherRecord> | AbstractEscherHolderRecord. getEscherRecords() | 
| java.util.Map<EscherRecord,Record> | EscherAggregate. getShapeToObjMapping() | 
| 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 | 
| Modifier and Type | Method and Description | 
|---|---|
| protected EscherRecord | HSSFClientAnchor. getEscherAnchor() | 
| protected EscherRecord | HSSFChildAnchor. getEscherAnchor() | 
| protected abstract EscherRecord | HSSFAnchor. getEscherAnchor() | 
| 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 | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.List<EscherRecord> | PICFAndOfficeArtData. getBlipRecords() | 
| java.util.List<EscherRecord> | EscherRecordHolder. getEscherRecords() | 
Copyright 2018 The Apache Software Foundation or its licensors, as applicable.