Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hslf » [javadoc | source]
org.apache.poi.hslf
public class: HSLFSlideShow [javadoc | source]
java.lang.Object
   org.apache.poi.POIDocument
      org.apache.poi.hslf.HSLFSlideShow
This class contains the main functionality for the Powerpoint file "reader". It is only a very basic class for now
Fields inherited from org.apache.poi.POIDocument:
sInf,  dsInf,  filesystem,  directory,  logger,  initialized
Constructor:
 public HSLFSlideShow() throws IOException 
    Constructs a new, empty, Powerpoint document.
 public HSLFSlideShow(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.
 public HSLFSlideShow(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.
 public HSLFSlideShow(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.
 public HSLFSlideShow(DirectoryNode dir,
    POIFSFileSystem filesystem) 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
    filesystem - the POIFS FileSystem to read from
    Throws:
    IOException - if there is a problem while parsing the document.
Method from org.apache.poi.hslf.HSLFSlideShow Summary:
addPicture,   appendRootLevelRecord,   close,   getCurrentUserAtom,   getEmbeddedObjects,   getPOIFSFileSystem,   getPictures,   getRecords,   getUnderlyingBytes,   write,   write
Methods from org.apache.poi.POIDocument:
copyNodes,   getDocumentSummaryInformation,   getPropertySet,   getSummaryInformation,   readProperties,   write,   writeProperties,   writeProperties,   writePropertySet
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hslf.HSLFSlideShow Detail:
 public  void addPicture(PictureData img) 
    Add a new picture to this presentation.
 public synchronized int appendRootLevelRecord(Record newRecord) 
    Adds a new root level record, at the end, but before the last PersistPtrIncrementalBlock.
 public  void close() throws IOException 
    Shuts things down. Closes underlying streams etc
 public CurrentUserAtom getCurrentUserAtom() 
    Fetch the Current User Atom of the document
 public ObjectData[] getEmbeddedObjects() 
    Gets embedded object data from the slide show.
 protected POIFSFileSystem getPOIFSFileSystem() 
    Returns the underlying POIFSFileSystem for the document that is open.
 public PictureData[] getPictures() 
    Return array of pictures contained in this presentation
 public Record[] getRecords() 
    Returns an array of all the records found in the slideshow
 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!
 public  void write(OutputStream out) throws IOException 
    Writes out the slideshow file the is represented by an instance of this class. It will write out the common OLE2 streams. If you require all streams to be written out, pass in preserveNodes
 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 to true