com.aspose.slides
Class Slide

java.lang.Object
  extended by com.aspose.slides.Slide
Direct Known Subclasses:
MainMaster

public class Slide
extends java.lang.Object

Represents the slide in a presentation.


Method Summary
 void addNotes()
          Adds the empty notes to a slide.
 void changeMaster(Slide newMaster)
          Replaces the master slide for a slide and changes placeholder's style.
 void changeMaster(Slide newMaster, boolean changeStyle)
          Replaces the master slide for a slide and optionally changes placeholder's style.
 Shape findShape(java.lang.String alt_text)
          Search and return the shape with defined alternative text.
 Background getBackground()
          Returns the background of a slide.
 HeaderFooter getHeaderFooter()
          Returns the header and footer settings for a slide.
 int getLayout()
          Returns the slide layout.
 long getMasterId()
          Returns the Id of a master slide.
 java.lang.String getName()
          Returns the name of a slide.
 Notes getNotes()
          Returns the notes of a slide.
 Presentation getParent()
          Returns the parent presentation.
 Placeholders getPlaceholders()
          Returns the placeholders of a slide.
 Shapes getShapes()
          Returns the shapes of a slide.
 long getSlideId()
          Returns the Id of a slide.
 int getSlidePosition()
          Returns the position of a slide.
 SlideShowTransition getSlideShowTransition()
          Returns the SlideShowTransition object which contains information about how the specified slide advances during a slide show.
 Tags getTags()
          Returns the tags of a slide.
 java.awt.image.BufferedImage getThumbnail(java.awt.Dimension size)
          Returns the thumbnail image object with specified size.
 java.awt.image.BufferedImage getThumbnail(double scaleX, double scaleY)
          Returns the thumbnail image object with custom scaling.
 boolean isFollowMasterBackground()
          Determines whether the slide follows the master slide background.
 boolean isFollowMasterObjects()
          Determines whether the slide objects follow the master slide objects style.
 boolean isFollowMasterScheme()
          Determines whether the slide follows the master slide color scheme.
 boolean isMasterSlide()
          Determines whether the slide is a master slide.
 void saveToSVG(java.io.OutputStream stream)
          Creates image of a slide in SVG (vector graphics) format and writes it to a stream.
 void saveToSVG(java.io.OutputStream stream, com.aspose.slides.SVGOptions svgOptions)
          Creates image of a slide in SVG (vector graphics) format and writes it to a stream.
 void setFollowMasterBackground(boolean value)
          Sets whether the slide follows the master slide background.
 void setFollowMasterObjects(boolean value)
          Sets whether the slide objects follow the master slide objects style.
 void setFollowMasterScheme(boolean value)
          Sets whether the slide follows the master slide color scheme.
 void setLayout(int value)
          Sets the slide layout.
 void setMasterId(long value)
          Sets the ID of a master slide.
 void setName(java.lang.String value)
          Sets the name of a slide.
 void setSlidePosition(int value)
          Sets the position of a slide.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

addNotes

public void addNotes()
              throws PptEditException
Adds the empty notes to a slide.

Throws:
PptEditException - on notes adding errors.

getParent

public Presentation getParent()
Returns the parent presentation.

Returns:
The parent presentation.

getNotes

public Notes getNotes()
Returns the notes of a slide.

Returns:
The notes of a slide.

getShapes

public Shapes getShapes()
Returns the shapes of a slide.

Returns:
The shapes of a slide.

getPlaceholders

public Placeholders getPlaceholders()
Returns the placeholders of a slide.

Returns:
The placeholders of a slide.

getBackground

public Background getBackground()
Returns the background of a slide.

Returns:
The background of a slide.

getSlideId

public long getSlideId()
Returns the Id of a slide.

Returns:
The slide Id.

getMasterId

public long getMasterId()
Returns the Id of a master slide.

Returns:
The master slide Id.

setMasterId

public void setMasterId(long value)
Sets the ID of a master slide.

Parameters:
value - the new Id of a master slide.

isMasterSlide

public boolean isMasterSlide()
Determines whether the slide is a master slide.

Returns:
true if slide is a master slide.

getSlidePosition

public int getSlidePosition()
Returns the position of a slide. Returns 0 for master slides.

Returns:
The slide position.

setSlidePosition

public void setSlidePosition(int value)
Sets the position of a slide. Do nothing for master slides.

Parameters:
value - new slide position.

getLayout

public int getLayout()
Returns the slide layout.

Returns:
The slide layout. See SlideLayout.

setLayout

public void setLayout(int value)
Sets the slide layout.

Parameters:
value - new slide layout. See SlideLayout.

isFollowMasterObjects

public boolean isFollowMasterObjects()
Determines whether the slide objects follow the master slide objects style.

Returns:
true if slide objects follow the master slide objects style.

setFollowMasterObjects

public void setFollowMasterObjects(boolean value)
Sets whether the slide objects follow the master slide objects style.

Parameters:
value - true to force slide objects follow the master slide objects style.

isFollowMasterScheme

public boolean isFollowMasterScheme()
Determines whether the slide follows the master slide color scheme.

Returns:
true if slide follows the master slide color scheme.

setFollowMasterScheme

public void setFollowMasterScheme(boolean value)
Sets whether the slide follows the master slide color scheme.

Parameters:
value - true to force slide follow the master slide color scheme.

isFollowMasterBackground

public boolean isFollowMasterBackground()
Determines whether the slide follows the master slide background.

Returns:
true if slide follows the master slide background.

setFollowMasterBackground

public void setFollowMasterBackground(boolean value)
Sets whether the slide follows the master slide background.

Parameters:
value - true to force slide follow the master slide background.

getName

public java.lang.String getName()
Returns the name of a slide.

Returns:
the name of a slide. See String.

setName

public void setName(java.lang.String value)
Sets the name of a slide.

Parameters:
value - the name of a slide. See String.

getThumbnail

public java.awt.image.BufferedImage getThumbnail(double scaleX,
                                                 double scaleY)
                                          throws PptException
Returns the thumbnail image object with custom scaling.

Parameters:
scaleX - The value by which to scale this Thumbnail in the x-axis direction.
scaleY - The value by which to scale this Thumbnail in the y-axis direction.
Returns:
the thumbnail image of a slide.
Throws:
PptException

getThumbnail

public java.awt.image.BufferedImage getThumbnail(java.awt.Dimension size)
                                          throws PptException
Returns the thumbnail image object with specified size.

Parameters:
size - of new Image.
Returns:
the thumbnail image of a slide.
Throws:
PptException

saveToSVG

public void saveToSVG(java.io.OutputStream stream)
               throws PptException,
                      AsposeLicenseException
Creates image of a slide in SVG (vector graphics) format and writes it to a stream.

Parameters:
stream - output stream.
Throws:
PptException
AsposeLicenseException

saveToSVG

public void saveToSVG(java.io.OutputStream stream,
                      com.aspose.slides.SVGOptions svgOptions)
               throws PptException,
                      AsposeLicenseException
Creates image of a slide in SVG (vector graphics) format and writes it to a stream.

Parameters:
stream - output stream.
svgOptions - options to create SVG file.
Throws:
PptException
AsposeLicenseException

getSlideShowTransition

public SlideShowTransition getSlideShowTransition()
Returns the SlideShowTransition object which contains information about how the specified slide advances during a slide show.

Returns:
The SlideShowTransition object.

changeMaster

public void changeMaster(Slide newMaster)
                  throws PptEditException
Replaces the master slide for a slide and changes placeholder's style.

Parameters:
newMaster - New master slide.
Throws:
PptEditException

changeMaster

public void changeMaster(Slide newMaster,
                         boolean changeStyle)
                  throws PptEditException
Replaces the master slide for a slide and optionally changes placeholder's style.

Parameters:
newMaster - New master slide.
changeStyle - true to change style of placeholders.
Throws:
PptEditException

getHeaderFooter

public HeaderFooter getHeaderFooter()
Returns the header and footer settings for a slide.

Returns:
the header and footer settings. See HeaderFooter.

getTags

public Tags getTags()
Returns the tags of a slide.

Returns:
The tags of a slide. See Tags.

findShape

public Shape findShape(java.lang.String alt_text)
Search and return the shape with defined alternative text.

Parameters:
alt_text - Alternative text to find.
Returns:
Shape object.