com.aspose.slides

Class Sequence

java.lang.Object

com.aspose.slides.Sequence

All Implemented Interfaces:

com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IEffect>, com.aspose.ms.System.Collections.IEnumerable<IEffect>, ISequence, java.lang.Iterable<IEffect>

public final class Sequence
extends java.lang.Object
implements ISequence

Represents sequence (collection of effects).

Method Summary

Modifier and Type	Method and Description
IEffect	addEffect(IChart chart, int type, int index, int effectType, int subtype, int triggerType) Adds the new chart animation effect for category or series to the end of sequence.
IEffect	addEffect(IChart chart, int type, int seriesIndex, int categoriesIndex, int effectType, int subtype, int triggerType) Adds the new chart animation effect for elements in category or series to the end of sequence.
IEffect	addEffect(IParagraph paragraph, int effectType, int subtype, int triggerType) Add new animation effect for paragraph to the end of sequence.
IEffect	addEffect(IShape shape, int effectType, int subtype, int triggerType) Add new effect to the end of sequence.
void	clear() Removes all effects from a collection.
IEffect	get_Item(int index) Returns an effect at the specified index.
int	getCount() Returns the number of effects in a sequense.
int	getCount(IShape shape) Returns count of effects for the specified shape.
IEffect[]	getEffectsByParagraph(IParagraph paragraph) Returns array of effects for the specified paragraph.
IEffect[]	getEffectsByShape(IShape shape) Returns array of effects for the specified shape.
IShape	getTriggerShape() Returns or sets shape target for INTERACTIVE sequence.
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IEffect>	iterator() Returns an enumerator that iterates through the collection.
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IEffect>	iteratorJava() Returns a java iterator for the entire collection.
void	remove(IEffect item) Removes specified effect from a collection.
void	removeAt(int index) Removes an effect from a collection.
void	removeByShape(IShape shape) Remove effect for the specified shape.
void	setTriggerShape(IShape value) Returns or sets shape target for INTERACTIVE sequence.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getCount

public final int getCount()

Returns the number of effects in a sequense. Read-only int.

Specified by:

getCount in interface ISequence

remove

public final void remove(IEffect item)

Removes specified effect from a collection.

Specified by:

remove in interface ISequence

Parameters:

item - Effect to remove.

removeAt

public final void removeAt(int index)

Removes an effect from a collection.

Specified by:

removeAt in interface ISequence

Parameters:

index - Index of a effect that should be deleted.

clear

public final void clear()

Removes all effects from a collection.

Specified by:

clear in interface ISequence

get_Item

public final IEffect get_Item(int index)

Returns an effect at the specified index.

Specified by:

get_Item in interface ISequence

Parameters:

index - Index of element.

Returns:

The IEffect object.

iterator

public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IEffect> iterator()

Returns an enumerator that iterates through the collection.

Specified by:

iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IEffect>

Specified by:

iterator in interface com.aspose.ms.System.Collections.IEnumerable<IEffect>

Specified by:

iterator in interface java.lang.Iterable<IEffect>

Returns:

A IGenericEnumerator that can be used to iterate through the collection.

iteratorJava

public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IEffect> iteratorJava()

Returns a java iterator for the entire collection.

Returns:

An Iterator for the entire collection.

getTriggerShape

public final IShape getTriggerShape()

Returns or sets shape target for INTERACTIVE sequence. If sequence is not interactive then returns null. Read/write IShape.

Specified by:

getTriggerShape in interface ISequence

setTriggerShape

public final void setTriggerShape(IShape value)

Returns or sets shape target for INTERACTIVE sequence. If sequence is not interactive then returns null. Read/write IShape.

Specified by:

setTriggerShape in interface ISequence

removeByShape

public final void removeByShape(IShape shape)

Remove effect for the specified shape.

Specified by:

removeByShape in interface ISequence

Parameters:

shape - Shape object IShape

getEffectsByShape

public final IEffect[] getEffectsByShape(IShape shape)

Returns array of effects for the specified shape.

Specified by:

getEffectsByShape in interface ISequence

Parameters:

shape - Shape object IShape

Returns:

Array of effects IEffect

getEffectsByParagraph

public final IEffect[] getEffectsByParagraph(IParagraph paragraph)

Returns array of effects for the specified paragraph.

Specified by:

getEffectsByParagraph in interface ISequence

Parameters:

paragraph - Paragraph object IParagraph

Returns:

Array of effects IEffect

getCount

public final int getCount(IShape shape)

Returns count of effects for the specified shape.

Specified by:

getCount in interface ISequence

Parameters:

shape - Shape object IShape

Returns:

Count of effects int

addEffect

public final IEffect addEffect(IShape shape,
                               int effectType,
                               int subtype,
                               int triggerType)

Add new effect to the end of sequence.

Specified by:

addEffect in interface ISequence

Parameters:

shape - Shape object IShape for adding an effect

effectType - Type of an animation effect EffectType

subtype - Subtypes of animation effect EffectSubtype

triggerType - Trigger type of effect EffectTriggerType

Returns:

New effect object IEffect

addEffect

public final IEffect addEffect(IParagraph paragraph,
                               int effectType,
                               int subtype,
                               int triggerType)

Add new animation effect for paragraph to the end of sequence.

  
  Presentation presentation = new Presentation(path + "input.pptx");
  try
  {        
     // select paragraph to add effect
     IAutoShape autoShape = (IAutoShape)presentation.getSlides().get_Item(0).getShapes().get_Item(0);
     IParagraph paragraph = autoShape.getTextFrame().getParagraphs().get_Item(0);
     // add Fly animation effect to selected paragraph
     IEffect effect = presentation.getSlides().get_Item(0).getTimeline().getMainSequence().addEffect(
     paragraph, EffectType.Fly, EffectSubtype.Left, EffectTriggerType.OnClick);
  }  finally {
     if (presentation != null) presentation.dispose();
  }
  
  

Specified by:

addEffect in interface ISequence

Parameters:

paragraph - Paragraph object IParagraph

effectType - Type of an animation effect EffectType

subtype - Subtypes of animation effect EffectSubtype

triggerType - Trigger type of effect EffectTriggerType

Returns:

New effect object IEffect

addEffect

public final IEffect addEffect(IChart chart,
                               int type,
                               int index,
                               int effectType,
                               int subtype,
                               int triggerType)

Adds the new chart animation effect for category or series to the end of sequence.

Specified by:

addEffect in interface ISequence

Parameters:

chart - Chart object IChart

type - Type of an animation effect EffectChartMinorGroupingType

index - Index int

effectType - Type of an animation effect EffectType

subtype - Subtypes of animation effect EffectSubtype

triggerType - Trigger type of effect EffectTriggerType

Returns:

New effect object IEffect

addEffect

public final IEffect addEffect(IChart chart,
                               int type,
                               int seriesIndex,
                               int categoriesIndex,
                               int effectType,
                               int subtype,
                               int triggerType)

Adds the new chart animation effect for elements in category or series to the end of sequence.

Specified by:

addEffect in interface ISequence

Parameters:

chart - Chart object IChart

type - Type of an animation effect EffectChartMinorGroupingType

seriesIndex - Index of chart series int

categoriesIndex - Index of category int

effectType - Type of an animation effect EffectType

subtype - Subtypes of animation effect EffectSubtype

triggerType - Trigger type of effect EffectTriggerType

Returns:

New effect object IEffect