Class HSLFSlideShowImpl

java.lang.Object
org.apache.poi.POIDocument
org.apache.poi.hslf.usermodel.HSLFSlideShowImpl
All Implemented Interfaces:
Closeable, AutoCloseable

public final class HSLFSlideShowImpl extends POIDocument implements Closeable
This class contains the main functionality for the Powerpoint file "reader". It is only a very basic class for now
  • Constructor Details

    • HSLFSlideShowImpl

      public HSLFSlideShowImpl(String fileName) throws IOException
      Constructs a Powerpoint document from fileName. Parses the document and places all the important stuff into data structures.
      Parameters:
      fileName - The name of the file to read.
      Throws:
      IOException - if there is a problem while parsing the document.
    • HSLFSlideShowImpl

      public HSLFSlideShowImpl(InputStream inputStream) throws IOException
      Constructs a Powerpoint document from an input stream. Parses the document and places all the important stuff into data structures.
      Parameters:
      inputStream - the source of the data
      Throws:
      IOException - if there is a problem while parsing the document.
    • HSLFSlideShowImpl

      public HSLFSlideShowImpl(POIFSFileSystem filesystem) throws IOException
      Constructs a Powerpoint document from a POIFS Filesystem. Parses the document and places all the important stuff into data structures.
      Parameters:
      filesystem - the POIFS FileSystem to read from
      Throws:
      IOException - if there is a problem while parsing the document.
    • HSLFSlideShowImpl

      public HSLFSlideShowImpl(DirectoryNode dir) throws IOException
      Constructs a Powerpoint document from a specific point in a POIFS Filesystem. Parses the document and places all the important stuff into data structures.
      Parameters:
      dir - the POIFS directory to read from
      Throws:
      IOException - if there is a problem while parsing the document.
  • Method Details

    • create

      public static HSLFSlideShowImpl create()
      Constructs a new, empty, Powerpoint document.
    • getDocumentEncryptionAtom

      public DocumentEncryptionAtom getDocumentEncryptionAtom()
    • normalizeRecords

      public void normalizeRecords()
      remove duplicated UserEditAtoms and merge PersistPtrHolder, i.e. remove document edit history
    • updateAndWriteDependantRecords

      public void updateAndWriteDependantRecords(OutputStream os, Map<RecordTypes,PositionDependentRecord> interestingRecords) throws IOException
      This is a helper functions, which is needed for adding new position dependent records or finally write the slideshow to a file.
      Parameters:
      os - the stream to write to, if null only the references are updated
      interestingRecords - a map of interesting records (PersistPtrHolder and UserEditAtom) referenced by their RecordType. Only the very last of each type will be saved to the map. May be null, if not needed.
      Throws:
      IOException
    • write

      public void write() throws IOException
      Writes out the slideshow to the currently open file.

      This will fail (with an IllegalStateException if the slideshow was opened read-only, opened from an InputStream instead of a File, or if this is not the root document. For those cases, you must use write(OutputStream) or write(File) to write to a brand new document.

      Specified by:
      write in class POIDocument
      Throws:
      IOException - thrown on errors writing to the file
      IllegalStateException - if this isn't from a writable File
      Since:
      POI 3.15 beta 3
    • write

      public void write(File newFile) throws IOException
      Writes out the slideshow file the is represented by an instance of this class.

      This will write out only the common OLE2 streams. If you require all streams to be written out, use write(File, boolean) with preserveNodes set to true.

      Specified by:
      write in class POIDocument
      Parameters:
      newFile - The File to write to.
      Throws:
      IOException - If there is an unexpected IOException from writing to the File
    • write

      public void write(File newFile, boolean preserveNodes) throws IOException
      Writes out the slideshow file the is represented by an instance of this class. If you require all streams to be written out (eg Marcos, embeded documents), then set preserveNodes set to true
      Parameters:
      newFile - The File to write to.
      preserveNodes - Should all OLE2 streams be written back out, or only the common ones?
      Throws:
      IOException - If there is an unexpected IOException from writing to the File
    • write

      public void write(OutputStream out) throws IOException
      Writes out the slideshow file the is represented by an instance of this class.

      This will write out only the common OLE2 streams. If you require all streams to be written out, use write(OutputStream, boolean) with preserveNodes set to true.

      Specified by:
      write in class POIDocument
      Parameters:
      out - The OutputStream to write to.
      Throws:
      IOException - If there is an unexpected IOException from the passed in OutputStream
    • write

      public void write(OutputStream out, boolean preserveNodes) throws IOException
      Writes out the slideshow file the is represented by an instance of this class. If you require all streams to be written out (eg Marcos, embeded documents), then set preserveNodes set to true
      Parameters:
      out - The OutputStream to write to.
      preserveNodes - Should all OLE2 streams be written back out, or only the common ones?
      Throws:
      IOException - If there is an unexpected IOException from the passed in OutputStream
    • getEncryptionInfo

      public EncryptionInfo getEncryptionInfo()
      Overrides:
      getEncryptionInfo in class POIDocument
      Returns:
      the encryption info if the document is encrypted, otherwise null
    • appendRootLevelRecord

      public int appendRootLevelRecord(Record newRecord)
      Adds a new root level record, at the end, but before the last PersistPtrIncrementalBlock.
    • addPicture

      public int addPicture(HSLFPictureData img)
      Add a new picture to this presentation.
      Returns:
      offset of this picture in the Pictures stream
    • getRecords

      public Record[] getRecords()
      Returns an array of all the records found in the slideshow
    • getUnderlyingBytes

      public byte[] getUnderlyingBytes()
      Returns an array of the bytes of the file. Only correct after a call to open or write - at all other times might be wrong!
    • getCurrentUserAtom

      public CurrentUserAtom getCurrentUserAtom()
      Fetch the Current User Atom of the document
    • getPictureData

      public List<HSLFPictureData> getPictureData()
      Return list of pictures contained in this presentation
      Returns:
      list with the read pictures or an empty list if the presentation doesn't contain pictures.
    • getEmbeddedObjects

      public HSLFObjectData[] getEmbeddedObjects()
      Gets embedded object data from the slide show.
      Returns:
      the embedded objects.
    • close

      public void close() throws IOException
      Description copied from class: POIDocument
      Closes the underlying POIFSFileSystem from which the document was read, if any. Has no effect on documents opened from an InputStream, or newly created ones.

      Once close() has been called, no further operations should be called on the document.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Overrides:
      close in class POIDocument
      Throws:
      IOException
    • getEncryptedPropertyStreamName

      protected String getEncryptedPropertyStreamName()
      Overrides:
      getEncryptedPropertyStreamName in class POIDocument
      Returns:
      the stream name of the property set collection, if the document is encrypted