public final class HSLFSlideShow extends POIDocument
Modifier and Type | Field | Description |
---|---|---|
static int |
UNSET_OFFSET |
directory
Constructor | Description |
---|---|
HSLFSlideShow(java.io.InputStream inputStream) |
Constructs a Powerpoint document from an input stream.
|
HSLFSlideShow(java.lang.String fileName) |
Constructs a Powerpoint document from fileName.
|
HSLFSlideShow(DirectoryNode dir) |
Constructs a Powerpoint document from a specific point in a
POIFS Filesystem.
|
HSLFSlideShow(DirectoryNode dir,
POIFSFileSystem filesystem) |
Deprecated.
Use
HSLFSlideShow(DirectoryNode) instead |
HSLFSlideShow(NPOIFSFileSystem filesystem) |
Constructs a Powerpoint document from a POIFS Filesystem.
|
HSLFSlideShow(POIFSFileSystem filesystem) |
Constructs a Powerpoint document from a POIFS Filesystem.
|
Modifier and Type | Method | Description |
---|---|---|
int |
addPicture(PictureData img) |
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.
|
static HSLFSlideShow |
create() |
Constructs a new, empty, Powerpoint document.
|
CurrentUserAtom |
getCurrentUserAtom() |
Fetch the Current User Atom of the document
|
DocumentEncryptionAtom |
getDocumentEncryptionAtom() |
|
ObjectData[] |
getEmbeddedObjects() |
Gets embedded object data from the slide show.
|
PictureData[] |
getPictures() |
Return array of pictures contained in this presentation
|
protected DirectoryNode |
getPOIFSDirectory() |
Returns the directory in the underlying POIFSFileSystem for the
document that is open.
|
protected POIFSFileSystem |
getPOIFSFileSystem() |
Returns the underlying POIFSFileSystem for the document
that is open.
|
protected PropertySet |
getPropertySet(java.lang.String setName) |
For a given named property entry, either return it or null if
if it wasn't found
|
Record[] |
getRecords() |
Returns an array of all the records found in the slideshow
|
byte[] |
getUnderlyingBytes() |
Returns an array of the bytes of the file.
|
void |
normalizeRecords() |
remove duplicated UserEditAtoms and merge PersistPtrHolder, i.e.
|
void |
updateAndWriteDependantRecords(java.io.OutputStream os,
java.util.Map<RecordTypes.Type,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(java.io.OutputStream out) |
Writes out the slideshow file the is represented by an instance
of this class.
|
void |
write(java.io.OutputStream out,
boolean preserveNodes) |
Writes out the slideshow file the is represented by an instance
of this class.
|
protected void |
writeProperties(POIFSFileSystem outFS,
java.util.List<java.lang.String> writtenEntries) |
Writes out the standard Documment Information Properties (HPSF)
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
copyNodeRecursively, copyNodes, copyNodes, createInformationProperties, getDocumentSummaryInformation, getPropertySet, getSummaryInformation, readProperties, writeProperties, writePropertySet
public static final int UNSET_OFFSET
public HSLFSlideShow(java.lang.String fileName) throws java.io.IOException
fileName
- The name of the file to read.java.io.IOException
- if there is a problem while parsing the document.public HSLFSlideShow(java.io.InputStream inputStream) throws java.io.IOException
inputStream
- the source of the datajava.io.IOException
- if there is a problem while parsing the document.public HSLFSlideShow(POIFSFileSystem filesystem) throws java.io.IOException
filesystem
- the POIFS FileSystem to read fromjava.io.IOException
- if there is a problem while parsing the document.public HSLFSlideShow(NPOIFSFileSystem filesystem) throws java.io.IOException
filesystem
- the POIFS FileSystem to read fromjava.io.IOException
- if there is a problem while parsing the document.@Deprecated public HSLFSlideShow(DirectoryNode dir, POIFSFileSystem filesystem) throws java.io.IOException
HSLFSlideShow(DirectoryNode)
insteaddir
- the POIFS directory to read fromfilesystem
- the POIFS FileSystem to read fromjava.io.IOException
- if there is a problem while parsing the document.public HSLFSlideShow(DirectoryNode dir) throws java.io.IOException
dir
- the POIFS directory to read fromjava.io.IOException
- if there is a problem while parsing the document.protected POIFSFileSystem getPOIFSFileSystem()
protected DirectoryNode getPOIFSDirectory()
public static final HSLFSlideShow create()
public DocumentEncryptionAtom getDocumentEncryptionAtom()
public void normalizeRecords()
public void updateAndWriteDependantRecords(java.io.OutputStream os, java.util.Map<RecordTypes.Type,PositionDependentRecord> interestingRecords) throws java.io.IOException
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.java.io.IOException
public void write(java.io.OutputStream out) throws java.io.IOException
write
in class POIDocument
out
- The OutputStream to write to.java.io.IOException
- If there is an unexpected IOException from
the passed in OutputStreampublic void write(java.io.OutputStream out, boolean preserveNodes) throws java.io.IOException
out
- The OutputStream to write to.preserveNodes
- Should all OLE2 streams be written back out, or only the common ones?java.io.IOException
- If there is an unexpected IOException from
the passed in OutputStreamprotected PropertySet getPropertySet(java.lang.String setName)
getPropertySet
in class POIDocument
setName
- The property to readprotected void writeProperties(POIFSFileSystem outFS, java.util.List<java.lang.String> writtenEntries) throws java.io.IOException
writeProperties
in class POIDocument
outFS
- the POIFSFileSystem to write the properties intowrittenEntries
- a list of POIFS entries to add the property names toojava.io.IOException
- if an error when writing to the
POIFSFileSystem
occurspublic int appendRootLevelRecord(Record newRecord)
public int addPicture(PictureData img)
public Record[] getRecords()
public byte[] getUnderlyingBytes()
public CurrentUserAtom getCurrentUserAtom()
public PictureData[] getPictures()
null
if the
presentation doesn't contain pictures.public ObjectData[] getEmbeddedObjects()
Copyright 2018 The Apache Software Foundation or its licensors, as applicable.