org.apache.poi.hslf
Class HSLFSlideShow

java.lang.Object
  extended byorg.apache.poi.hslf.HSLFSlideShow

public class HSLFSlideShow
extends java.lang.Object

This class contains the main functionality for the Powerpoint file "reader". It is only a very basic class for now

Author:
Nick Burch

Constructor Summary
HSLFSlideShow(java.io.InputStream inputStream)
          Constructs a Powerpoint document from an input stream.
HSLFSlideShow(POIFSFileSystem filesystem)
          Constructs a Powerpoint document from a POIFS Filesystem.
HSLFSlideShow(java.lang.String fileName)
          Constructs a Powerpoint document from fileName.
 
Method Summary
 void close()
          Shuts things down.
 CurrentUserAtom getCurrentUserAtom()
          Fetch the Current User Atom of the document
 DocumentSummaryInformation getDocumentSummaryInformation()
          Fetch the Document Summary Information of the document
 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
 SummaryInformation getSummaryInformation()
          Fetch the Summary Information of the document
 byte[] getUnderlyingBytes()
          Returns an array of the bytes of the file.
 void readProperties()
          Find the properties from the filesystem, and load them
 void write(java.io.OutputStream out)
          Writes out the slideshow file the is represented by an instance of this class
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HSLFSlideShow

public HSLFSlideShow(java.lang.String fileName)
              throws java.io.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:
java.io.IOException - if there is a problem while parsing the document.

HSLFSlideShow

public HSLFSlideShow(java.io.InputStream inputStream)
              throws java.io.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:
java.io.IOException - if there is a problem while parsing the document.

HSLFSlideShow

public HSLFSlideShow(POIFSFileSystem filesystem)
              throws java.io.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:
java.io.IOException - if there is a problem while parsing the document.
Method Detail

close

public void close()
           throws java.io.IOException
Shuts things down. Closes underlying streams etc

Throws:
java.io.IOException

readProperties

public void readProperties()
Find the properties from the filesystem, and load them


getPropertySet

public PropertySet getPropertySet(java.lang.String setName)
For a given named property entry, either return it or null if if it wasn't found


write

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

Parameters:
out - The OutputStream to write to.
Throws:
java.io.IOException - If there is an unexpected IOException from the passed in OutputStream

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!


getDocumentSummaryInformation

public DocumentSummaryInformation getDocumentSummaryInformation()
Fetch the Document Summary Information of the document


getSummaryInformation

public SummaryInformation getSummaryInformation()
Fetch the Summary Information of the document


getCurrentUserAtom

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



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