com.aspose.slides

Class BaseSlide

java.lang.Object

com.aspose.slides.BaseSlide

All Implemented Interfaces:

IBaseSlide, IPresentationComponent, ISlideComponent, IThemeable

Direct Known Subclasses:

LayoutSlide, MasterHandoutSlide, MasterNotesSlide, MasterSlide, NotesSlide, Slide

public abstract class BaseSlide
extends java.lang.Object
implements IBaseSlide

Represents common data for all slide types.

Method Summary

Modifier and Type	Method and Description
IThemeEffectiveData	createThemeEffective() Returns an effective theme for this slide.
boolean	equals(IBaseSlide slide) Determines whether the two IBaseSlide instances are equal.
IShape	findShapeByAltText(java.lang.String altText) Finds first occurrence of a shape with the specified alternative text.
IBackground	getBackground() Returns slide's background.
IControlCollection	getControls() Returns the collection of ActiveX controls on a slide.
ICustomData	getCustomData() Returns the slide's custom data.
IHyperlinkQueries	getHyperlinkQueries() Provides easy access to contained hyperlinks.
java.lang.String	getName() Returns or sets the name of a slide.
com.aspose.slides.IDOMObject	getParent_Immediate() Returns Parent_Immediate object.
IPresentation	getPresentation() Returns IPresentation interface.
IShapeCollection	getShapes() Returns the shapes of a slide.
abstract boolean	getShowMasterShapes() Specifies if shapes on the master slide should be shown on slides or not.
IBaseSlide	getSlide() Returns the base slide.
long	getSlideId() Returns the ID of a slide.
ISlideShowTransition	getSlideShowTransition() Returns the Transition object which contains information about how the specified slide advances during a slide show.
IAnimationTimeLine	getTimeline() Returns animation timeline object.
void	joinPortionsWithSameFormatting() Joins runs with same formatting in all paragraphs all acceptable shapes.
void	joinPortionsWithSameFormatting(IShapeCollection collection) Joins runs with same formatting in all paragraphs in all acceptable shapes.
void	setName(java.lang.String value) Returns or sets the name of a slide.
abstract void	setShowMasterShapes(boolean value) Specifies if shapes on the master slide should be shown on slides or not.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getShapes

public final IShapeCollection getShapes()

Returns the shapes of a slide. Read-only IShapeCollection.

Specified by:

getShapes in interface IBaseSlide

getControls

public final IControlCollection getControls()

Returns the collection of ActiveX controls on a slide. Read-only IControlCollection.

Specified by:

getControls in interface IBaseSlide

getName

public java.lang.String getName()

Returns or sets the name of a slide. Read/write String.

Specified by:

getName in interface IBaseSlide

setName

public void setName(java.lang.String value)

Returns or sets the name of a slide. Read/write String.

Specified by:

setName in interface IBaseSlide

getSlideId

public final long getSlideId()

Returns the ID of a slide. Read-only long.

Specified by:

getSlideId in interface IBaseSlide

equals

public final boolean equals(IBaseSlide slide)

Determines whether the two IBaseSlide instances are equal. Returning value is calculated based on slide's structure and static content. Two slides are equal if all shapes, styles, texts, animation and other settings. etc. are equal. The comparison doesn't take into account unique identifier values, e.g. SlideId and dynamic content, e.g. current date value in Date Placeholder.

 The following example shows how to compare two slides.
 
 Presentation presentation1 = new Presentation("AccessSlides.pptx");
 try {
     Presentation presentation2 = new Presentation("HelloWorld.pptx");
     try {
         for (int i = 0; i < presentation1.getMasters().size(); i++)
         {
             for (int j = 0; j < presentation2.getMasters().size(); j++)
             {
                 if (presentation1.getMasters().get_Item(i).equals(presentation2.getMasters().get_Item(j)))
                     System.out.println(String.format("SomePresentation1 MasterSlide#%d is equal to SomePresentation2 MasterSlide#%d", i, j));
             }
         }
     } finally {
         if (presentation2 != null) presentation2.dispose();
     }
 } finally {
     if (presentation1 != null) presentation1.dispose();
 }
 
 

Specified by:

equals in interface IBaseSlide

Parameters:

slide - The IBaseSlide to compare with the current IBaseSlide.

Returns:

<b>true</b> if the specified IBaseSlide is equal to the current IBaseSlide; otherwise, <b>false</b>.

joinPortionsWithSameFormatting

public void joinPortionsWithSameFormatting()

Joins runs with same formatting in all paragraphs all acceptable shapes.

Specified by:

joinPortionsWithSameFormatting in interface IBaseSlide

joinPortionsWithSameFormatting

public void joinPortionsWithSameFormatting(IShapeCollection collection)

Joins runs with same formatting in all paragraphs in all acceptable shapes.

createThemeEffective

public final IThemeEffectiveData createThemeEffective()

Returns an effective theme for this slide.

Specified by:

createThemeEffective in interface IThemeable

Returns:

Effective theme IThemeEffectiveData

getCustomData

public final ICustomData getCustomData()

Returns the slide's custom data. Read-only ICustomData.

Specified by:

getCustomData in interface IBaseSlide

getTimeline

public final IAnimationTimeLine getTimeline()

Returns animation timeline object. Read-only IAnimationTimeLine.

Specified by:

getTimeline in interface IBaseSlide

getSlideShowTransition

public ISlideShowTransition getSlideShowTransition()

Returns the Transition object which contains information about how the specified slide advances during a slide show. Read-only ISlideShowTransition.

Specified by:

getSlideShowTransition in interface IBaseSlide

getBackground

public final IBackground getBackground()

Returns slide's background. Read-only IBackground.

Specified by:

getBackground in interface IBaseSlide

getHyperlinkQueries

public final IHyperlinkQueries getHyperlinkQueries()

Provides easy access to contained hyperlinks. Read-only IHyperlinkQueries.

Specified by:

getHyperlinkQueries in interface IBaseSlide

getShowMasterShapes

public abstract boolean getShowMasterShapes()

Specifies if shapes on the master slide should be shown on slides or not. For master slide itself this property always returns false. Read/write boolean.

Specified by:

getShowMasterShapes in interface IBaseSlide

Throws:

com.aspose.ms.System.NotSupportedException - Thrown if set true for master slide.

setShowMasterShapes

public abstract void setShowMasterShapes(boolean value)

Specifies if shapes on the master slide should be shown on slides or not. For master slide itself this property always returns false. Read/write boolean.

Specified by:

setShowMasterShapes in interface IBaseSlide

Throws:

com.aspose.ms.System.NotSupportedException - Thrown if set true for master slide.

findShapeByAltText

public final IShape findShapeByAltText(java.lang.String altText)

Finds first occurrence of a shape with the specified alternative text.

Specified by:

findShapeByAltText in interface IBaseSlide

Parameters:

altText - Alternative text.

Returns:

Shape object or null.

getParent_Immediate

public final com.aspose.slides.IDOMObject getParent_Immediate()

Returns Parent_Immediate object. Read-only IDOMObject.

getPresentation

public final IPresentation getPresentation()

Returns IPresentation interface. Read-only IPresentation.

Specified by:

getPresentation in interface IPresentationComponent

getSlide

public final IBaseSlide getSlide()

Description copied from interface: ISlideComponent

Returns the base slide. Read-only IBaseSlide.

Specified by:

getSlide in interface ISlideComponent