org.apache.poi.hslf.record
Class DocumentAtom

java.lang.Object
  extended by org.apache.poi.hslf.record.Record
      extended by org.apache.poi.hslf.record.RecordAtom
          extended by org.apache.poi.hslf.record.DocumentAtom

public final class DocumentAtom
extends RecordAtom

A Document Atom (type 1001). Holds misc information on the PowerPoint document, lots of them size and scale related.

Author:
Nick Burch

Nested Class Summary
static class DocumentAtom.SlideSize
          Holds the different Slide Size values
 
Field Summary
 
Fields inherited from class org.apache.poi.hslf.record.Record
logger
 
Constructor Summary
protected DocumentAtom(byte[] source, int start, int len)
          For the Document Atom
 
Method Summary
 int getFirstSlideNum()
           
 long getHandoutMasterPersist()
          Returns a reference to the HandoutMaster, or 0 if none
 long getNotesMasterPersist()
          Returns a reference to the NotesMaster, or 0 if none
 long getNotesSizeX()
           
 long getNotesSizeY()
           
 boolean getOmitTitlePlace()
          Have the placeholders on the title slide been omitted?
 long getRecordType()
          We are of type 1001
 boolean getRightToLeft()
          Is this a Bi-Directional PPT Doc?
 boolean getSaveWithFonts()
          Was the document saved with True Type fonts embeded?
 long getServerZoomFrom()
           
 long getServerZoomTo()
           
 boolean getShowComments()
          Are comment shapes visible?
 int getSlideSizeType()
          The Size of the Document's slides, @see DocumentAtom.SlideSize for values
 long getSlideSizeX()
           
 long getSlideSizeY()
           
 void setNotesSizeX(long x)
           
 void setNotesSizeY(long y)
           
 void setServerZoomFrom(long zoom)
           
 void setServerZoomTo(long zoom)
           
 void setSlideSizeX(long x)
           
 void setSlideSizeY(long y)
           
 void writeOut(java.io.OutputStream out)
          Write the contents of the record back, so it can be written to disk
 
Methods inherited from class org.apache.poi.hslf.record.RecordAtom
getChildRecords, isAnAtom
 
Methods inherited from class org.apache.poi.hslf.record.Record
buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentAtom

protected DocumentAtom(byte[] source,
                       int start,
                       int len)
For the Document Atom

Method Detail

getSlideSizeX

public long getSlideSizeX()

getSlideSizeY

public long getSlideSizeY()

getNotesSizeX

public long getNotesSizeX()

getNotesSizeY

public long getNotesSizeY()

setSlideSizeX

public void setSlideSizeX(long x)

setSlideSizeY

public void setSlideSizeY(long y)

setNotesSizeX

public void setNotesSizeX(long x)

setNotesSizeY

public void setNotesSizeY(long y)

getServerZoomFrom

public long getServerZoomFrom()

getServerZoomTo

public long getServerZoomTo()

setServerZoomFrom

public void setServerZoomFrom(long zoom)

setServerZoomTo

public void setServerZoomTo(long zoom)

getNotesMasterPersist

public long getNotesMasterPersist()
Returns a reference to the NotesMaster, or 0 if none


getHandoutMasterPersist

public long getHandoutMasterPersist()
Returns a reference to the HandoutMaster, or 0 if none


getFirstSlideNum

public int getFirstSlideNum()

getSlideSizeType

public int getSlideSizeType()
The Size of the Document's slides, @see DocumentAtom.SlideSize for values


getSaveWithFonts

public boolean getSaveWithFonts()
Was the document saved with True Type fonts embeded?


getOmitTitlePlace

public boolean getOmitTitlePlace()
Have the placeholders on the title slide been omitted?


getRightToLeft

public boolean getRightToLeft()
Is this a Bi-Directional PPT Doc?


getShowComments

public boolean getShowComments()
Are comment shapes visible?


getRecordType

public long getRecordType()
We are of type 1001

Specified by:
getRecordType in class Record

writeOut

public void writeOut(java.io.OutputStream out)
              throws java.io.IOException
Write the contents of the record back, so it can be written to disk

Specified by:
writeOut in class Record
Throws:
java.io.IOException


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