Package org.apache.poi.hslf.usermodel
Class HSLFSlideShowImpl
java.lang.Object
org.apache.poi.POIDocument
org.apache.poi.hslf.usermodel.HSLFSlideShowImpl
- All Implemented Interfaces:
Closeable
,AutoCloseable
This class contains the main functionality for the Powerpoint file
"reader". It is only a very basic class for now
-
Constructor Summary
ConstructorsConstructorDescriptionHSLFSlideShowImpl
(InputStream inputStream) Constructs a Powerpoint document from an input stream.HSLFSlideShowImpl
(String fileName) Constructs a Powerpoint document from fileName.Constructs a Powerpoint document from a specific point in a POIFS Filesystem.HSLFSlideShowImpl
(POIFSFileSystem filesystem) Constructs a Powerpoint document from a POIFS Filesystem. -
Method Summary
Modifier and TypeMethodDescriptionint
Add a new picture to this presentation.int
appendRootLevelRecord
(Record newRecord) Adds a new root level record, at the end, but before the last PersistPtrIncrementalBlock.void
close()
Closes the underlyingPOIFSFileSystem
from which the document was read, if any.static HSLFSlideShowImpl
create()
Constructs a new, empty, Powerpoint document.Fetch the Current User Atom of the documentGets embedded object data from the slide show.protected String
Return list of pictures contained in this presentationRecord[]
Returns an array of all the records found in the slideshowbyte[]
Returns an array of the bytes of the file.void
remove duplicated UserEditAtoms and merge PersistPtrHolder, i.e.void
updateAndWriteDependantRecords
(OutputStream os, Map<RecordTypes, PositionDependentRecord> interestingRecords) This is a helper functions, which is needed for adding new position dependent records or finally write the slideshow to a file.void
write()
Writes out the slideshow to the currently open file.void
Writes out the slideshow file the is represented by an instance of this class.void
Writes out the slideshow file the is represented by an instance of this class.void
write
(OutputStream out) Writes out the slideshow file the is represented by an instance of this class.void
write
(OutputStream out, boolean preserveNodes) Writes out the slideshow file the is represented by an instance of this class.Methods inherited from class org.apache.poi.POIDocument
clearDirectory, createInformationProperties, getDirectory, getDocumentSummaryInformation, getPropertySet, getPropertySet, getSummaryInformation, initDirectory, readProperties, replaceDirectory, validateInPlaceWritePossible, writeProperties, writeProperties, writeProperties
-
Constructor Details
-
HSLFSlideShowImpl
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
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
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
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
Constructs a new, empty, Powerpoint document. -
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 IOExceptionThis 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 updatedinterestingRecords
- 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
Writes out the slideshow to the currently open file.This will fail (with an
IllegalStateException
if the slideshow was opened read-only, opened from anInputStream
instead of a File, or if this is not the root document. For those cases, you must usewrite(OutputStream)
orwrite(File)
to write to a brand new document.- Specified by:
write
in classPOIDocument
- Throws:
IOException
- thrown on errors writing to the fileIllegalStateException
- if this isn't from a writable File- Since:
- POI 3.15 beta 3
-
write
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)
withpreserveNodes
set totrue
.- Specified by:
write
in classPOIDocument
- Parameters:
newFile
- The File to write to.- Throws:
IOException
- If there is an unexpected IOException from writing to the File
-
write
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 setpreserveNodes
set totrue
- 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
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)
withpreserveNodes
set totrue
.- Specified by:
write
in classPOIDocument
- Parameters:
out
- The OutputStream to write to.- Throws:
IOException
- If there is an unexpected IOException from the passed in OutputStream
-
write
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 setpreserveNodes
set totrue
- 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
- Overrides:
getEncryptionInfo
in classPOIDocument
- Returns:
- the encryption info if the document is encrypted, otherwise
null
-
appendRootLevelRecord
Adds a new root level record, at the end, but before the last PersistPtrIncrementalBlock. -
addPicture
Add a new picture to this presentation.- Returns:
- offset of this picture in the Pictures stream
-
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
Fetch the Current User Atom of the document -
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
Gets embedded object data from the slide show.- Returns:
- the embedded objects.
-
close
Description copied from class:POIDocument
Closes the underlyingPOIFSFileSystem
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 interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classPOIDocument
- Throws:
IOException
-
getEncryptedPropertyStreamName
- Overrides:
getEncryptedPropertyStreamName
in classPOIDocument
- Returns:
- the stream name of the property set collection, if the document is encrypted
-