org.apache.poi.hslf.model
Class Sheet

java.lang.Object
  extended by org.apache.poi.hslf.model.Sheet
Direct Known Subclasses:
MasterSheet, Notes, Slide

public abstract class Sheet
extends java.lang.Object

This class defines the common format of "Sheets" in a powerpoint document. Such sheets could be Slides, Notes, Master etc

Author:
Nick Burch

Constructor Summary
Sheet()
           
 
Method Summary
abstract  int _getSheetNumber()
          Returns the (internal, SlideIdentifier based) sheet number, as used to reference this sheet from other records.
abstract  int _getSheetRefId()
          Returns the (internal, RefID based) sheet number, as used to in PersistPtr stuff.
 void addShape(Shape shape)
          Add a new Shape to this Slide
static TextRun[] findTextRuns(PPDrawing ppdrawing)
          For a given PPDrawing, grab all the TextRuns
protected static void findTextRuns(Record[] records, java.util.Vector found)
          Scans through the supplied record array, looking for a TextHeaderAtom followed by one of a TextBytesAtom or a TextCharsAtom.
 ColorSchemeAtom getColorScheme()
          Color scheme for this sheet.
 MasterSheet getMasterSheet()
          Return the master sheet .
protected abstract  PPDrawing getPPDrawing()
          Fetch the PPDrawing from the underlying record
 Shape[] getShapes()
          Returns all shapes contained in this Sheet
 SlideShow getSlideShow()
          Fetch the SlideShow we're attached to
abstract  TextRun[] getTextRuns()
          Returns an array of all the TextRuns in the sheet.
 void setSlideShow(SlideShow ss)
          Set the SlideShow we're attached to.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Sheet

public Sheet()
Method Detail

getTextRuns

public abstract TextRun[] getTextRuns()
Returns an array of all the TextRuns in the sheet.


_getSheetRefId

public abstract int _getSheetRefId()
Returns the (internal, RefID based) sheet number, as used to in PersistPtr stuff.


_getSheetNumber

public abstract int _getSheetNumber()
Returns the (internal, SlideIdentifier based) sheet number, as used to reference this sheet from other records.


getPPDrawing

protected abstract PPDrawing getPPDrawing()
Fetch the PPDrawing from the underlying record


getSlideShow

public SlideShow getSlideShow()
Fetch the SlideShow we're attached to


setSlideShow

public void setSlideShow(SlideShow ss)
Set the SlideShow we're attached to. Also passes it on to our child RichTextRuns


findTextRuns

public static TextRun[] findTextRuns(PPDrawing ppdrawing)
For a given PPDrawing, grab all the TextRuns


findTextRuns

protected static void findTextRuns(Record[] records,
                                   java.util.Vector found)
Scans through the supplied record array, looking for a TextHeaderAtom followed by one of a TextBytesAtom or a TextCharsAtom. Builds up TextRuns from these

Parameters:
records - the records to build from
found - vector to add any found to

getShapes

public Shape[] getShapes()
Returns all shapes contained in this Sheet

Returns:
all shapes contained in this Sheet (Slide or Notes)

addShape

public void addShape(Shape shape)
Add a new Shape to this Slide

Parameters:
shape - - the Shape to add

getMasterSheet

public MasterSheet getMasterSheet()
Return the master sheet .


getColorScheme

public ColorSchemeAtom getColorScheme()
Color scheme for this sheet.



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