|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.POIDocument
org.apache.poi.hslf.HSLFSlideShow
public final class HSLFSlideShow
This class contains the main functionality for the Powerpoint file "reader". It is only a very basic class for now
Field Summary | |
---|---|
static int |
UNSET_OFFSET
|
Fields inherited from class org.apache.poi.POIDocument |
---|
directory |
Constructor Summary | |
---|---|
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(java.io.InputStream inputStream)
Constructs a Powerpoint document from an input stream. |
|
HSLFSlideShow(NPOIFSFileSystem filesystem)
Constructs a Powerpoint document from a POIFS Filesystem. |
|
HSLFSlideShow(POIFSFileSystem filesystem)
Constructs a Powerpoint document from a POIFS Filesystem. |
|
HSLFSlideShow(java.lang.String fileName)
Constructs a Powerpoint document from fileName. |
Method Summary | |
---|---|
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 |
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. |
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 |
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. |
Methods inherited from class org.apache.poi.POIDocument |
---|
copyNodeRecursively, copyNodes, copyNodes, createInformationProperties, getDocumentSummaryInformation, getPropertySet, getSummaryInformation, readProperties, writeProperties, writeProperties, writePropertySet |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int UNSET_OFFSET
Constructor Detail |
---|
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 data
java.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 from
java.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 from
java.io.IOException
- if there is a problem while parsing the document.@Deprecated public HSLFSlideShow(DirectoryNode dir, POIFSFileSystem filesystem) throws java.io.IOException
HSLFSlideShow(DirectoryNode)
instead
dir
- the POIFS directory to read fromfilesystem
- the POIFS FileSystem to read from
java.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 from
java.io.IOException
- if there is a problem while parsing the document.Method Detail |
---|
protected POIFSFileSystem getPOIFSFileSystem()
protected DirectoryNode getPOIFSDirectory()
public static final HSLFSlideShow create()
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 OutputStreampublic 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()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |