com.aspose.slides
Class AnimationSettings

java.lang.Object
  extended by com.aspose.slides.AnimationSettings

public final class AnimationSettings
extends java.lang.Object

Represents an animation effects you can apply to the specified shape.


Method Summary
 int getAdvanceMode()
          Returns the value that indicates whether the specified shape animation advances only when clicked or automatically after a specified amount of time.
 double getAdvanceTime()
          Returns the amount of time, in seconds, after which the specified shape animation will occur.
 int getAfterEffect()
          Determines whether the specified slide advances automatically after a specified amount of time has elapsed.
 int getAnimationOrder()
          Returns the integer that represents the position of the specified shape within the collection of shapes to be animated.
 int getAnimationSlideCount()
          Returns the number of slides where shape will be animated.
 int getEntryEffect()
          Returns the special effect applied to the specified shape animation.
 int getTextLevelEffect()
          Returns the constant that indicates whether the text in the specified shape is animated by first-level paragraphs, second-level paragraphs, or some other level (up to fifth-level paragraphs).
 int getTextUnitEffect()
          Returns the constant that indicates whether the text in the specified shape is animated paragraph by paragraph, word by word, or letter by letter.
 boolean isAnimateBackground()
          Determines whether the shape is animated together with the text it contains.
 boolean isAnimateTextInReverse()
          Determines whether the specified shape is animated in reverse order.
 void setAdvanceMode(int value)
          Sets the value that indicates whether the specified shape animation advances only when clicked or automatically after a specified amount of time.
 void setAdvanceTime(double value)
          Sets the amount of time, in seconds, after which the specified shape animation will occur.
 void setAfterEffect(int value)
          Sets whether the specified slide advances automatically after a specified amount of time has elapsed.
 void setAnimateBackground(boolean value)
          Sets whether the shape is animated together with the text it contains.
 void setAnimateTextInReverse(boolean value)
          Sets whether the specified shape is animated in reverse order.
 void setAnimationOrder(int value)
          Sets the integer that represents the position of the specified shape within the collection of shapes to be animated.
 void setAnimationSlideCount(int value)
          Sets the number of slides where shape will be animated.
 void setEntryEffect(int value)
          Sets the special effect applied to the specified shape animation.
 void setTextLevelEffect(int value)
          Sets the constant that indicates whether the text in the specified shape is animated by first-level paragraphs, second-level paragraphs, or some other level (up to fifth-level paragraphs).
 void setTextUnitEffect(int value)
          Sets the constant that indicates whether the text in the specified shape is animated paragraph by paragraph, word by word, or letter by letter.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getEntryEffect

public int getEntryEffect()
Returns the special effect applied to the specified shape animation.

Returns:
The entry effect. See ShapeEntryEffect.

setEntryEffect

public void setEntryEffect(int value)
Sets the special effect applied to the specified shape animation.

Parameters:
value - new entry effect. See ShapeEntryEffect.

getAnimationOrder

public int getAnimationOrder()
Returns the integer that represents the position of the specified shape within the collection of shapes to be animated.

Returns:
The animation order.

setAnimationOrder

public void setAnimationOrder(int value)
Sets the integer that represents the position of the specified shape within the collection of shapes to be animated.

Parameters:
value - new animation order.

getAnimationSlideCount

public int getAnimationSlideCount()
Returns the number of slides where shape will be animated.

Returns:
The number of slides.

setAnimationSlideCount

public void setAnimationSlideCount(int value)
Sets the number of slides where shape will be animated.

Parameters:
value - the number of slides.

getAdvanceTime

public double getAdvanceTime()
Returns the amount of time, in seconds, after which the specified shape animation will occur.

Returns:
The advance time.

setAdvanceTime

public void setAdvanceTime(double value)
Sets the amount of time, in seconds, after which the specified shape animation will occur.

Parameters:
value - new advance time.

getAdvanceMode

public int getAdvanceMode()
Returns the value that indicates whether the specified shape animation advances only when clicked or automatically after a specified amount of time.

Returns:
The advance mode. See ShapeAdvanceMode.

setAdvanceMode

public void setAdvanceMode(int value)
Sets the value that indicates whether the specified shape animation advances only when clicked or automatically after a specified amount of time.

Parameters:
value - new advance mode. See ShapeAdvanceMode.

getAfterEffect

public int getAfterEffect()
Determines whether the specified slide advances automatically after a specified amount of time has elapsed.

Returns:
The after effect. See ShapeAfterEffect.

setAfterEffect

public void setAfterEffect(int value)
Sets whether the specified slide advances automatically after a specified amount of time has elapsed.

Parameters:
value - new after effect. See ShapeAfterEffect.

getTextUnitEffect

public int getTextUnitEffect()
Returns the constant that indicates whether the text in the specified shape is animated paragraph by paragraph, word by word, or letter by letter.

Returns:
The text unit effect. See TextUnitEffect.

setTextUnitEffect

public void setTextUnitEffect(int value)
Sets the constant that indicates whether the text in the specified shape is animated paragraph by paragraph, word by word, or letter by letter.

Parameters:
value - new text unit effect. See TextUnitEffect.

getTextLevelEffect

public int getTextLevelEffect()
Returns the constant that indicates whether the text in the specified shape is animated by first-level paragraphs, second-level paragraphs, or some other level (up to fifth-level paragraphs).

Returns:
The text level effect. See TextLevelEffect.

setTextLevelEffect

public void setTextLevelEffect(int value)
Sets the constant that indicates whether the text in the specified shape is animated by first-level paragraphs, second-level paragraphs, or some other level (up to fifth-level paragraphs).

Parameters:
value - new text level effect. See TextLevelEffect.

isAnimateTextInReverse

public boolean isAnimateTextInReverse()
Determines whether the specified shape is animated in reverse order.

Returns:
true if text animated in reverse order.

setAnimateTextInReverse

public void setAnimateTextInReverse(boolean value)
Sets whether the specified shape is animated in reverse order.

Parameters:
value - true to set text animation in reverse order.

isAnimateBackground

public boolean isAnimateBackground()
Determines whether the shape is animated together with the text it contains.

Returns:
true if the shape is animated together with text.

setAnimateBackground

public void setAnimateBackground(boolean value)
Sets whether the shape is animated together with the text it contains.

Parameters:
value - true if the shape is animated together with text.