## Uses of Class
org.apache.poi.hslf.record.Record

- Packages that use Record
  Package | Description
  --- | ---
  org.apache.poi.hslf.dev |
  org.apache.poi.hslf.record |
  org.apache.poi.hslf.usermodel |

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

    Methods in org.apache.poi.hslf.dev that return Record
    Modifier and Type | Method and Description
    --- | ---
    `static Record` | UserEditAndPersistListing.`findRecordAtPos(int pos)`
    `static Record` | SlideIdListing.`findRecordAtPos(int pos)`

    Methods in org.apache.poi.hslf.dev with parameters of type Record
    Modifier and Type | Method and Description
    --- | ---
    `int` | SlideShowRecordDumper.`getDiskLen(Record r)`
    `java.lang.String` | SlideShowRecordDumper.`getPrintableRecordContents(Record r)`
    `void` | SlideShowRecordDumper.`walkTree(int depth, int pos, Record[] records, int indent)`

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

    Classes in org.apache.poi.hslf.record with type parameters of type Record
    Modifier and Type | Interface and Description
    --- | ---
    `static interface` | `RecordTypes.RecordConstructor<T extends Record>`

    Subclasses of Record in org.apache.poi.hslf.record
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AnimationInfo` A container record that specifies information about animation information for a shape.
    `class` | `AnimationInfoAtom` An atom record that specifies the animation information for a shape.
    `class` | `BinaryTagDataBlob` If we come across a record we know has children of (potential) interest, but where the record itself is boring, but where other records may care about where this one lives, we create one of these.
    `class` | `ColorSchemeAtom` A ColorSchemeAtom (type 2032).
    `class` | `Comment2000` This class represents a comment on a slide, in the format used by PPT 2000/XP/etc.
    `class` | `Comment2000Atom` An atomic record containing information about a comment.
    `class` | `CString` A CString (type 4026).
    `class` | `DocInfoListContainer` A container record that specifies information about the document and document display settings.
    `class` | `Document` Master container for Document.
    `class` | `DocumentAtom` A Document Atom (type 1001).
    `class` | `DocumentEncryptionAtom` A Document Encryption Atom (type 12052).
    `class` | `DummyPositionSensitiveRecordWithChildren` If we come across a record we know has children of (potential) interest, but where the record itself is boring, but where other records may care about where this one lives, we create one of these.
    `class` | `DummyRecordWithChildren` If we come across a record we know has children of (potential) interest, but where the record itself is boring, we create one of these.
    `class` | `Environment` Environment, which contains lots of settings for the document.
    `class` | `EscherTextboxWrapper` A wrapper around a DDF (Escher) EscherTextbox Record.
    `class` | `ExAviMovie` A container record that specifies information about a movie stored externally.
    `class` | `ExControl` A container record that specifies information about an ActiveX control.
    `class` | `ExControlAtom` An atom record that specifies an ActiveX control.
    `class` | `ExEmbed` This data represents an embedded object in the document.
    `class` | `ExEmbedAtom` The atom that holds metadata on a specific embedded object in the document.
    `class` | `ExHyperlink` This class represents the data of a link in the document.
    `class` | `ExHyperlinkAtom` Tne atom that holds metadata on a specific Link in the document.
    `class` | `ExMCIMovie` A container record that specifies information about a movie stored externally.
    `class` | `ExMediaAtom` An atom record that specifies information about external audio or video data.
    `class` | `ExObjList` This class holds the links to exernal objects referenced from the document.
    `class` | `ExObjListAtom` Tne atom that holds the seed info used by a ExObjList
    `class` | `ExObjRefAtom` ExObjRefAtom (3009).
    `class` | `ExOleObjAtom` Atom storing information for an OLE object.
    `class` | `ExOleObjStg` Storage for embedded OLE objects.
    `class` | `ExVideoContainer` A container record that specifies information about external video data.
    `class` | `FontCollection` `FontCollection` ia a container that holds information about all the fonts in the presentation.
    `class` | `FontEmbeddedData`
    `class` | `FontEntityAtom` This atom corresponds exactly to a Windows Logical Font (LOGFONT) structure.
    `class` | `HeadersFootersAtom` An atom record that specifies options for displaying headers and footers on a presentation slide or notes slide.
    `class` | `HeadersFootersContainer` A container record that specifies information about the footers on a presentation slide.
    `class` | `InteractiveInfo` This class represents the metadata of a link in a slide/notes/etc.
    `class` | `InteractiveInfoAtom` Tne atom that holds metadata on Links in the document.
    `class` | `MainMaster` Master slide
    `class` | `MasterTextPropAtom` Specifies the Indent Level for the text
    `class` | `Notes` Master container for Notes.
    `class` | `NotesAtom` A Notes Atom (type 1009).
    `class` | `OEPlaceholderAtom` OEPlaceholderAtom (3011).
    `class` | `OutlineTextRefAtom` OEPlaceholderAtom (3998).
    `class` | `PersistPtrHolder` General holder for PersistPtrFullBlock and PersistPtrIncrementalBlock records.
    `class` | `PositionDependentRecordAtom` A special (and dangerous) kind of Record Atom that cares about where it lives on the disk, or who has other Atoms that care about where this is on the disk.
    `class` | `PositionDependentRecordContainer` A special (and dangerous) kind of Record Container, for which other Atoms care about where this one lives on disk.
    `class` | `PPDrawing` These are actually wrappers onto Escher drawings.
    `class` | `PPDrawingGroup` Container records which always exists inside Document.
    `class` | `RecordAtom` Abstract class which all atom records will extend.
    `class` | `RecordContainer` Abstract class which all container records will extend.
    `class` | `RoundTripHFPlaceholder12` An atom record that specifies that a shape is a header or footer placeholder shape
    `class` | `SheetContainer` The superclass of all sheet container records - Slide, Notes, MainMaster, etc.
    `class` | `Slide` Master container for Slides.
    `class` | `SlideAtom` A Slide Atom (type 1007).
    `class` | `SlideListWithText` These are tricky beasts.
    `class` | `SlidePersistAtom` A SlidePersist Atom (type 1011).
    `class` | `Sound` A container holding information about a sound.
    `class` | `SoundCollection` Is a container for all sound related atoms and containers.
    `class` | `SoundData` Storage for embedded sounds.
    `class` | `SSSlideInfoAtom` A SlideShowSlideInfo Atom (type 1017). An atom record that specifies which transition effects to perform during a slide show, and how to advance to the next presentation slide. Combination of effectType and effectDirection: typedescriptiondirection 0cut0x00 = no transition, 0x01 = black transition 1random0x00 2blinds0x00 = vertical, 0x01 = horizontal 3checkerlike blinds 4cover0x00 = left, 0x01 = up, 0x02 = right, 0x03 = down, 0x04 = left/up, 0x05 = right/up, 0x06 left/down, 0x07 = left/down 5dissolve0x00 6fade0x00 7uncoverlike cover 8random barslike blinds 9stripslike 0x04 - 0x07 of cover 10wipelike 0x00 - 0x03 of cover 11box in/out0x00 = out, 0x01 = in 13split0x00 = horizontally out, 0x01 = horizontally in, 0x02 = vertically out, 0x03 = vertically in 17diamond0x00 18plus0x00 19wedge0x00 20pushlike 0x00 - 0x03 of cover 21comblike blinds 22newsflash0x00 23alphafade0x00 26wheelnumber of radial divisions (0x01,0x02,0x03,0x04,0x08) 27circle0x00 255undefined0x00
    `class` | `StyleTextProp9Atom` The atom record that specifies additional text formatting.
    `class` | `StyleTextPropAtom` A StyleTextPropAtom (type 4001).
    `class` | `TextBytesAtom` A TextBytesAtom (type 4008).
    `class` | `TextCharsAtom` A TextCharsAtom (type 4000).
    `class` | `TextHeaderAtom` A TextHeaderAtom (type 3999).
    `class` | `TextRulerAtom` Ruler of a text as it differs from the style's ruler settings.
    `class` | `TextSpecInfoAtom` The special info runs contained in this text.
    `class` | `TxInteractiveInfoAtom` Tne atom that holds starting and ending character positions of a hyperlink
    `class` | `TxMasterStyleAtom` TxMasterStyleAtom atom (4003).
    `class` | `UnknownRecordPlaceholder` If we come across a record we don't know about, we create one of these.
    `class` | `UserEditAtom` A UserEdit Atom (type 4085).
    `class` | `VBAInfoAtom` An atom record that specifies a reference to the VBA project storage.
    `class` | `VBAInfoContainer` A container record that specifies VBA information for the document.

    Fields in org.apache.poi.hslf.record declared as Record
    Modifier and Type | Field and Description
    --- | ---
    `protected Record[]` | RecordContainer.`_children`

    Methods in org.apache.poi.hslf.record that return Record
    Modifier and Type | Method and Description
    --- | ---
    `static Record` | Record.`buildRecordAtOffset(byte[] b, int offset)` Build and return the Record at the given offset.
    `static Record` | Record.`createRecordForType(long type, byte[] b, int start, int len)` For a given type (little endian bytes 3 and 4 in record header), byte array, start position and length: will return a Record object that will handle that record Remember that while PPT stores the record lengths as 8 bytes short (not including the size of the header), this code assumes you're passing in corrected lengths
    `static Record[]` | Record.`findChildRecords(byte[] b, int start, int len)` Default method for finding child records of a container record
    `Record` | RecordContainer.`findFirstOfType(long type)` Finds the first child record of the given type, or null if none of the child records are of the given type.
    `Record[]` | PPDrawing.`getChildRecords()` We're pretending to be an atom, so return null
    `Record[]` | PPDrawingGroup.`getChildRecords()` We're pretending to be an atom, so return null
    `abstract Record[]` | Record.`getChildRecords()` Fetch all the child records of this record If this record is an atom, will return null If this record is a non-atom, but has no children, will return an empty array
    `Record[]` | RecordAtom.`getChildRecords()` We're an atom, returns null
    `Record[]` | RecordContainer.`getChildRecords()` Return any children
    `Record[]` | SlideListWithText.SlideAtomsSet.`getSlideRecords()` Get the Text related records for this slide
    `Record` | RecordContainer.`removeChild(Record ch)` Remove a child record from this record container

    Methods in org.apache.poi.hslf.record that return types with arguments of type Record
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<Record>` | Record.`getGenericChildren()`
    `java.util.List<? extends Record>` | HSLFEscherClientDataRecord.`getHSLFChildRecords()`

    Methods in org.apache.poi.hslf.record with parameters of type Record
    Modifier and Type | Method and Description
    --- | ---
    `void` | HSLFEscherClientDataRecord.`addChild(Record childRecord)`
    `int` | RecordContainer.`addChildAfter(Record newChild, Record after)` Adds the given Child Record after the supplied record
    `int` | RecordContainer.`addChildBefore(Record newChild, Record before)` Adds the given Child Record before the supplied record
    `int` | RecordContainer.`appendChildRecord(Record newChild)` Add a new child record onto a record's list of children.
    `void` | RecordContainer.`moveChildBefore(Record child, Record before)` Deprecated. method is not used within POI and will be removed
    `void` | RecordContainer.`moveChildrenAfter(Record firstChild, int number, Record after)` Deprecated. method is not used within POI and will be removed
    `void` | RecordContainer.`moveChildrenBefore(Record firstChild, int number, Record before)` Deprecated. method is not used within POI and will be removed
    `Record` | RecordContainer.`removeChild(Record ch)` Remove a child record from this record container
    `void` | RecordContainer.`setChildRecord(Record[] records)` Set child records.
    `void` | RecordContainer.`writeOut(byte headerA, byte headerB, long type, Record[] children, java.io.OutputStream out)` Write out our header, and our children.

    Method parameters in org.apache.poi.hslf.record with type arguments of type Record
    Modifier and Type | Method and Description
    --- | ---
    `void` | HSLFEscherClientDataRecord.`removeChild(java.lang.Class<? extends Record> childClass)`

    Constructors in org.apache.poi.hslf.record with parameters of type Record
    Constructor and Description
    `SlideAtomsSet(SlidePersistAtom s, Record[] r)` Create one to hold the Records for one Slide's text

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

    Methods in org.apache.poi.hslf.usermodel with type parameters of type Record
    Modifier and Type | Method and Description
    --- | ---
    `protected static <T extends Record> T` | HSLFShapeFactory.`getClientDataRecord(EscherContainerRecord spContainer, int recordType)`
    `<T extends Record> T` | HSLFShape.`getClientDataRecord(int recordType)` Find a record in the underlying EscherClientDataRecord

    Methods in org.apache.poi.hslf.usermodel that return Record
    Modifier and Type | Method and Description
    --- | ---
    `protected static Record[]` | HSLFSlideShowEncrypted.`addEncryptionRecord(Record[] records, DocumentEncryptionAtom dea)`
    `Record` | HSLFSlideShow.`getCoreRecordForRefID(int refID)` For a given refID (the internal, 0 based numbering scheme), return the core record
    `Record` | HSLFSlideShow.`getCoreRecordForSAS(SlideListWithText.SlideAtomsSet sas)` For a given SlideAtomsSet, return the core record, based on the refID from the SlidePersistAtom
    `Record[]` | HSLFSlideShow.`getMostRecentCoreRecords()` Returns an array of the most recent version of all the interesting records
    `Record[]` | HSLFTextParagraph.`getRecords()` Returns records that make up the list of text paragraphs (there can be misc InteractiveInfo, TxInteractiveInfo and other records)
    `Record[]` | HSLFSlideShowImpl.`getRecords()` Returns an array of all the records found in the slideshow
    `protected static Record[]` | HSLFSlideShowEncrypted.`normalizeRecords(Record[] records)` remove duplicated UserEditAtoms and merge PersistPtrHolder.
    `protected static Record[]` | HSLFSlideShowEncrypted.`removeEncryptionRecord(Record[] records)`
    `protected Record[]` | HSLFSlideShowEncrypted.`updateEncryptionRecord(Record[] records)`

    Methods in org.apache.poi.hslf.usermodel that return types with arguments of type Record
    Modifier and Type | Method and Description
    --- | ---
    `protected java.util.List<? extends Record>` | HSLFShape.`getClientRecords()` Search for EscherClientDataRecord, if found, convert its contents into an array of HSLF records

    Methods in org.apache.poi.hslf.usermodel with parameters of type Record
    Modifier and Type | Method and Description
    --- | ---
    `protected static Record[]` | HSLFSlideShowEncrypted.`addEncryptionRecord(Record[] records, DocumentEncryptionAtom dea)`
    `int` | HSLFSlideShowImpl.`appendRootLevelRecord(Record newRecord)` Adds a new root level record, at the end, but before the last PersistPtrIncrementalBlock.
    `protected java.io.OutputStream` | HSLFSlideShowEncrypted.`encryptRecord(java.io.OutputStream plainStream, int persistId, Record record)`
    `protected static java.util.List<java.util.List<HSLFTextParagraph>>` | HSLFTextParagraph.`findTextParagraphs(Record[] records)` Scans through the supplied record array, looking for a TextHeaderAtom followed by one of a TextBytesAtom or a TextCharsAtom.
    `protected static Record[]` | HSLFSlideShowEncrypted.`normalizeRecords(Record[] records)` remove duplicated UserEditAtoms and merge PersistPtrHolder.
    `protected static Record[]` | HSLFSlideShowEncrypted.`removeEncryptionRecord(Record[] records)`
    `protected Record[]` | HSLFSlideShowEncrypted.`updateEncryptionRecord(Record[] records)`

    Constructor parameters in org.apache.poi.hslf.usermodel with type arguments of type Record
    Constructor and Description
    `HSLFSlideShowEncrypted(byte[] docstream, java.util.NavigableMap<java.lang.Integer,Record> recordMap)`

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