com.aspose.slides

Class Effect

java.lang.Object

com.aspose.slides.Effect

All Implemented Interfaces:

IEffect

public class Effect
extends java.lang.Object
implements IEffect

Represents animation effect.

Method Summary

Modifier and Type	Method and Description
IColorFormat	getAfterAnimationColor() Defines an after animation color for effect.
int	getAfterAnimationType() Defines an after animation type for effect.
int	getAnimateTextType() Defines an animate text type for effect.
IBehaviorCollection	getBehaviors() Returns collection of behavior for effect.
float	getDelayBetweenTextParts() Defines a delay between animated text parts (words or letters).
com.aspose.slides.IDOMObject	getParent_Immediate() Returns Parent_Immediate object.
int	getPresetClassType() Defines class of effect.
ISequence	getSequence() Returns a sequence for an effect.
IAudio	getSound() Defined embedded sound for effect.
boolean	getStopPreviousSound() This attribute specifies if the animation effect stops the previous sound.
int	getSubtype() Defines subtype of effect.
IShape	getTargetShape() Returns target shape for effect.
ITextAnimation	getTextAnimation() TextAnimation Read-only ITextAnimation.
ITiming	getTiming() Defines timing value for effect.
int	getType() Defines type of effect.
void	setAfterAnimationColor(IColorFormat value) Defines an after animation color for effect.
void	setAfterAnimationType(int value) Defines an after animation type for effect.
void	setAnimateTextType(int value) Defines an animate text type for effect.
void	setBehaviors(IBehaviorCollection value) Returns collection of behavior for effect.
void	setDelayBetweenTextParts(float value) Defines a delay between animated text parts (words or letters).
void	setPresetClassType(int value) Defines class of effect.
void	setSound(IAudio value) Defined embedded sound for effect.
void	setStopPreviousSound(boolean value) This attribute specifies if the animation effect stops the previous sound.
void	setSubtype(int value) Defines subtype of effect.
void	setTiming(ITiming value) Defines timing value for effect.
void	setType(int value) Defines type of effect.

Methods inherited from class java.lang.Object

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

Method Detail

getSequence

public final ISequence getSequence()

Returns a sequence for an effect. Read-only ISequence.

Specified by:

getSequence in interface IEffect

getTextAnimation

public final ITextAnimation getTextAnimation()

TextAnimation Read-only ITextAnimation.

Specified by:

getTextAnimation in interface IEffect

getPresetClassType

public final int getPresetClassType()

Defines class of effect. Read/write EffectPresetClassType.

Specified by:

getPresetClassType in interface IEffect

setPresetClassType

public final void setPresetClassType(int value)

Defines class of effect. Read/write EffectPresetClassType.

Specified by:

setPresetClassType in interface IEffect

getType

public final int getType()

Defines type of effect. Read/write EffectType.

Specified by:

getType in interface IEffect

setType

public final void setType(int value)

Defines type of effect. Read/write EffectType.

Specified by:

setType in interface IEffect

getSubtype

public final int getSubtype()

Defines subtype of effect. Read/write EffectSubtype.

Specified by:

getSubtype in interface IEffect

setSubtype

public final void setSubtype(int value)

Defines subtype of effect. Read/write EffectSubtype.

Specified by:

setSubtype in interface IEffect

getBehaviors

public final IBehaviorCollection getBehaviors()

Returns collection of behavior for effect. Read/write IBehaviorCollection.

Specified by:

getBehaviors in interface IEffect

setBehaviors

public final void setBehaviors(IBehaviorCollection value)

Returns collection of behavior for effect. Read/write IBehaviorCollection.

Specified by:

setBehaviors in interface IEffect

getTiming

public final ITiming getTiming()

Defines timing value for effect. Read/write ITiming.

Specified by:

getTiming in interface IEffect

setTiming

public final void setTiming(ITiming value)

Defines timing value for effect. Read/write ITiming.

Specified by:

setTiming in interface IEffect

getTargetShape

public final IShape getTargetShape()

Returns target shape for effect. Read-only IShape.

Specified by:

getTargetShape in interface IEffect

getSound

public final IAudio getSound()

Defined embedded sound for effect. Read/write IAudio.

 
 Presentation presentation = new Presentation("demo.pptx");
 try {
     ISlide slide = presentation.getSlides().get_Item(0);

     // Gets the effects sequence for the slide
     ISequence effectsSequence = slide.getTimeline().getMainSequence();

     for (IEffect effect : effectsSequence)
     {
         if (effect.getSound() == null)
             continue;

         // Extracts the effect sound in byte array
         byte[] audio = effect.getSound().getBinaryData();
     }
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

getSound in interface IEffect

setSound

public final void setSound(IAudio value)

Defined embedded sound for effect. Read/write IAudio.

 
 Presentation presentation = new Presentation("demo.pptx");
 try {
     ISlide slide = presentation.getSlides().get_Item(0);

     // Gets the effects sequence for the slide
     ISequence effectsSequence = slide.getTimeline().getMainSequence();

     for (IEffect effect : effectsSequence)
     {
         if (effect.getSound() == null)
             continue;

         // Extracts the effect sound in byte array
         byte[] audio = effect.getSound().getBinaryData();
     }
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

setSound in interface IEffect

getStopPreviousSound

public final boolean getStopPreviousSound()

This attribute specifies if the animation effect stops the previous sound. Read/write boolean.

 
 Presentation presentation = new Presentation("demo.pptx");
 try {
     // Get the first effect of the first slide.
     IEffect firstSlideEffect = presentation.getSlides().get_Item(0).getTimeline().getMainSequence().get_Item(0);

     // Get the first effect of the second slide.
     IEffect secondSlideEffect = presentation.getSlides().get_Item(1).getTimeline().getMainSequence().get_Item(0);

     if (firstSlideEffect.getSound() != null)
     {
         // Change the second effect Enhancements/Sound to "Stop Previous Sound"
         secondSlideEffect.setStopPreviousSound(true);
     }
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

getStopPreviousSound in interface IEffect

setStopPreviousSound

public final void setStopPreviousSound(boolean value)

This attribute specifies if the animation effect stops the previous sound. Read/write boolean.

 
 Presentation presentation = new Presentation("demo.pptx");
 try {
     // Get the first effect of the first slide.
     IEffect firstSlideEffect = presentation.getSlides().get_Item(0).getTimeline().getMainSequence().get_Item(0);

     // Get the first effect of the second slide.
     IEffect secondSlideEffect = presentation.getSlides().get_Item(1).getTimeline().getMainSequence().get_Item(0);

     if (firstSlideEffect.getSound() != null)
     {
         // Change the second effect Enhancements/Sound to "Stop Previous Sound"
         secondSlideEffect.setStopPreviousSound(true);
     }
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

setStopPreviousSound in interface IEffect

getAfterAnimationType

public final int getAfterAnimationType()

Defines an after animation type for effect. Read/write AfterAnimationType(getAfterAnimationType()/setAfterAnimationType(int)).

 
 Presentation presentation = new Presentation("demo.pptx");
 try {
     // Get the first effect of the first slide.
     IEffect firstSlideEffect = presentation.getSlides().get_Item(0).getTimeline().getMainSequence().get_Item(0);

     // Change the effect After animation to "Hide on Next Mouse Click"
     firstSlideEffect.setAfterAnimationType(AfterAnimationType.HideOnNextMouseClick);
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

getAfterAnimationType in interface IEffect

setAfterAnimationType

public final void setAfterAnimationType(int value)

Defines an after animation type for effect. Read/write AfterAnimationType(getAfterAnimationType()/setAfterAnimationType(int)).

 
 Presentation presentation = new Presentation("demo.pptx");
 try {
     // Get the first effect of the first slide.
     IEffect firstSlideEffect = presentation.getSlides().get_Item(0).getTimeline().getMainSequence().get_Item(0);

     // Change the effect After animation to "Hide on Next Mouse Click"
     firstSlideEffect.setAfterAnimationType(AfterAnimationType.HideOnNextMouseClick);
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

setAfterAnimationType in interface IEffect

getAfterAnimationColor

public final IColorFormat getAfterAnimationColor()

Defines an after animation color for effect. Read/write IColorFormat.

 
 Presentation presentation = new Presentation("demo.pptx");
 try {
     // Get the first effect of the first slide.
     IEffect firstSlideEffect = presentation.getSlides().get_Item(0).getTimeline().getMainSequence().get_Item(0);

     // Change the effect After animation type to "Color"
     firstSlideEffect.setAfterAnimationType(AfterAnimationType.Color);

     // Set the effect After animation color.
     firstSlideEffect.getAfterAnimationColor().setColor(new java.awt.Color(0, 255, 0, 255));
 }finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

getAfterAnimationColor in interface IEffect

setAfterAnimationColor

public final void setAfterAnimationColor(IColorFormat value)

Defines an after animation color for effect. Read/write IColorFormat.

 
 Presentation presentation = new Presentation("demo.pptx");
 try {
     // Get the first effect of the first slide.
     IEffect firstSlideEffect = presentation.getSlides().get_Item(0).getTimeline().getMainSequence().get_Item(0);

     // Change the effect After animation type to "Color"
     firstSlideEffect.setAfterAnimationType(AfterAnimationType.Color);

     // Set the effect After animation color.
     firstSlideEffect.getAfterAnimationColor().setColor(new java.awt.Color(0, 255, 0, 255));
 }finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

setAfterAnimationColor in interface IEffect

getAnimateTextType

public final int getAnimateTextType()

Defines an animate text type for effect. The shape text can be animated by letter, by word or all at once. Read/write AnimateTextType(getAnimateTextType()/setAnimateTextType(int)).

 
 Presentation presentation = new Presentation("demo.pptx");
 try {
     // Get the first effect of the first slide.
     IEffect firstSlideEffect = presentation.getSlides().get_Item(0).getTimeline().getMainSequence().get_Item(0);

     // Change the effect Animate text type to "By letter"
     firstSlideEffect.setAnimateTextType(AnimateTextType.ByLetter);
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

getAnimateTextType in interface IEffect

setAnimateTextType

public final void setAnimateTextType(int value)

Defines an animate text type for effect. The shape text can be animated by letter, by word or all at once. Read/write AnimateTextType(getAnimateTextType()/setAnimateTextType(int)).

 
 Presentation presentation = new Presentation("demo.pptx");
 try {
     // Get the first effect of the first slide.
     IEffect firstSlideEffect = presentation.getSlides().get_Item(0).getTimeline().getMainSequence().get_Item(0);

     // Change the effect Animate text type to "By letter"
     firstSlideEffect.setAnimateTextType(AnimateTextType.ByLetter);
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

setAnimateTextType in interface IEffect

getDelayBetweenTextParts

public final float getDelayBetweenTextParts()

Defines a delay between animated text parts (words or letters). A positive value specifies the percentage of effect duration. A negative value specifies the delay in seconds. Read/write float.

 
 Presentation presentation = new Presentation("demo.pptx");
 try {
    // Get the first effect of the first slide.
     IEffect firstSlideEffect = presentation.getSlides().get_Item(0).getTimeline().getMainSequence().get_Item(0);

     // Change the effect Animate text type to "By word"
     firstSlideEffect.setAnimateTextType(AnimateTextType.ByWord);

     // Set the delay between animated text parts to 20% of effect duration.
     firstSlideEffect.setDelayBetweenTextParts(20f);
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

getDelayBetweenTextParts in interface IEffect

setDelayBetweenTextParts

public final void setDelayBetweenTextParts(float value)

Defines a delay between animated text parts (words or letters). A positive value specifies the percentage of effect duration. A negative value specifies the delay in seconds. Read/write float.

 
 Presentation presentation = new Presentation("demo.pptx");
 try {
    // Get the first effect of the first slide.
     IEffect firstSlideEffect = presentation.getSlides().get_Item(0).getTimeline().getMainSequence().get_Item(0);

     // Change the effect Animate text type to "By word"
     firstSlideEffect.setAnimateTextType(AnimateTextType.ByWord);

     // Set the delay between animated text parts to 20% of effect duration.
     firstSlideEffect.setDelayBetweenTextParts(20f);
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

setDelayBetweenTextParts in interface IEffect

getParent_Immediate

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

Returns Parent_Immediate object. Read-only IDOMObject.