Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hslf » model » [javadoc | source]
org.apache.poi.hslf.model
public class: Slide [javadoc | source]
java.lang.Object
   org.apache.poi.hslf.model.Sheet
      org.apache.poi.hslf.model.Slide
This class represents a slide in a PowerPoint Document. It allows access to the text within, and the layout. For now, it only does the text side of things though
Constructor:
 public Slide(int sheetNumber,
    int sheetRefId,
    int slideNumber) 
 public Slide(Slide slide,
    Notes notes,
    SlideAtomsSet atomSet,
    int slideIdentifier,
    int slideNumber) 
    Constructs a Slide from the Slide record, and the SlideAtomsSet containing the text. Initialises TextRuns, to provide easier access to the text
    Parameters:
    slide - the Slide record we're based on
    notes - the Notes sheet attached to us
    atomSet - the SlideAtomsSet to get the text from
Method from org.apache.poi.hslf.model.Slide Summary:
addTitle,   draw,   getBackground,   getColorScheme,   getFollowMasterBackground,   getFollowMasterObjects,   getFollowMasterScheme,   getMasterSheet,   getNotesSheet,   getSlideAtomsSet,   getSlideNumber,   getSlideRecord,   getTextRuns,   getTitle,   onCreate,   setFollowMasterBackground,   setFollowMasterObjects,   setFollowMasterScheme,   setMasterSheet,   setNotes,   setSlideNumber
Methods from org.apache.poi.hslf.model.Sheet:
_getSheetNumber,   _getSheetRefId,   addShape,   allocateShapeId,   draw,   findTextRuns,   findTextRuns,   getBackground,   getColorScheme,   getMasterSheet,   getPPDrawing,   getShapes,   getSheetContainer,   getSlideShow,   getTextRuns,   onCreate,   removeShape,   setSlideShow
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hslf.model.Slide Detail:
 public TextBox addTitle() 
    Create a TextBox object that represents the slide's title.
 public  void draw(Graphics2D graphics) 
 public Background getBackground() 
    Background for this slide.
 public ColorSchemeAtom getColorScheme() 
    Color scheme for this slide.
 public boolean getFollowMasterBackground() 
    Whether this slide follows master sheet background
 public boolean getFollowMasterObjects() 
    Whether this slide draws master sheet objects
 public boolean getFollowMasterScheme() 
    Whether this slide follows master color scheme
 public MasterSheet getMasterSheet() 
    Returns master sheet associated with this slide. It can be either SlideMaster or TitleMaster objects.
 public Notes getNotesSheet() 
    Returns the Notes Sheet for this slide, or null if there isn't one
 protected SlideAtomsSet getSlideAtomsSet() 
 public int getSlideNumber() 
    Returns the (public facing) page number of this slide
 public Slide getSlideRecord() 
    Returns the underlying slide record
 public TextRun[] getTextRuns() 
    Returns an array of all the TextRuns found
 public String getTitle() 
    Return title of this slide or null if the slide does not have title.

    The title is a run of text of type TextHeaderAtom.CENTER_TITLE_TYPE or TextHeaderAtom.TITLE_TYPE

 public  void onCreate() 
    Called by SlideShow ater a new slide is created.

    For Slide we need to do the following:

  • set id of the drawing group.
  • set shapeId for the container descriptor and background

 public  void setFollowMasterBackground(boolean flag) 
    Sets whether this slide follows master background
 public  void setFollowMasterObjects(boolean flag) 
    Sets whether this slide draws master sheet objects
 public  void setFollowMasterScheme(boolean flag) 
    Sets whether this slide draws master color scheme
 public  void setMasterSheet(MasterSheet master) 
    Change Master of this slide.
 public  void setNotes(Notes notes) 
    Sets the Notes that are associated with this. Updates the references in the records to point to the new ID
 public  void setSlideNumber(int newSlideNumber) 
    Changes the Slide's (external facing) page number.