com.aspose.slides

Class GradientStopCollection

java.lang.Object

com.aspose.slides.PVIObject

com.aspose.slides.GradientStopCollection

All Implemented Interfaces:

com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IGradientStop>, com.aspose.ms.System.Collections.ICollection<IGradientStop>, com.aspose.ms.System.Collections.IEnumerable<IGradientStop>, IGenericCollection<IGradientStop>, IGradientStopCollection, IPresentationComponent, ISlideComponent, java.lang.Iterable<IGradientStop>

public final class GradientStopCollection
extends PVIObject
implements IGradientStopCollection

Represnts a collection of gradient stops.

Method Summary

Modifier and Type	Method and Description
IGradientStop	add(float position, java.awt.Color color) Creates the new gradient stop and adds it to the end of collection.
IGradientStop	addPresetColor(float position, int presetColor) Creates the new gradient stop and adds it to the end of collection.
IGradientStop	addSchemeColor(float position, int schemeColor) Creates the new gradient stop and adds it to the end of collection.
void	clear() Removes all gradient stops from a collection.
void	copyTo(com.aspose.ms.System.Array array, int index) Copies all elements from the collection to the specified array.
IGradientStop	get_Item(int index) Returns the gradient stop by index.
java.lang.Object	getSyncRoot() Returns a synchronization root.
long	getVersion() Version.
void	insert(int index, float position, java.awt.Color color) Creates the new gradient stop and inserts it at the specified index to the collection.
void	insertPresetColor(int index, float position, int presetColor) Creates the new gradient stop and inserts it at the specified index to the collection.
void	insertSchemeColor(int index, float position, int schemeColor) Creates the new gradient stop and inserts it at the specified index to the collection.
boolean	isSynchronized() Returns a value indicating whether access to the collection is synchronized (thread-safe).
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IGradientStop>	iterator() Returns an enumerator that iterates through the collection.
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IGradientStop>	iteratorJava() Returns a java iterator for the entire collection.
void	removeAt(int index) Removes a gradient stop at the specified index.
int	size() Returns the number of gradient stops in a collection.

Methods inherited from class com.aspose.slides.PVIObject

equals, getParent_Immediate, getParent_IPresentationComponent, getParent_ISlideComponent, getPresentation, getSlide, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getVersion

public long getVersion()

Version. Read-only long.

Overrides:

getVersion in class PVIObject

size

public final int size()

Returns the number of gradient stops in a collection. Read-only int.

Specified by:

size in interface com.aspose.ms.System.Collections.ICollection<IGradientStop>

get_Item

public final IGradientStop get_Item(int index)

Returns the gradient stop by index.

Specified by:

get_Item in interface IGradientStopCollection

add

public final IGradientStop add(float position,
                               java.awt.Color color)

Creates the new gradient stop and adds it to the end of collection.

Specified by:

add in interface IGradientStopCollection

Parameters:

position - Position of the new gradient stop.

color - Color of the new radient stop.

Returns:

Index of the new gradient stop in the collection.

addPresetColor

public final IGradientStop addPresetColor(float position,
                                          int presetColor)

Creates the new gradient stop and adds it to the end of collection.

Specified by:

addPresetColor in interface IGradientStopCollection

Parameters:

position - Position of the new gradient stop.

presetColor - Color of the new radient stop.

Returns:

Index of the new gradient stop in the collection.

addSchemeColor

public final IGradientStop addSchemeColor(float position,
                                          int schemeColor)

Creates the new gradient stop and adds it to the end of collection.

Specified by:

addSchemeColor in interface IGradientStopCollection

Parameters:

position - Position of the new gradient stop.

schemeColor - Color of the new radient stop.

Returns:

Index of the new gradient stop in the collection.

insert

public final void insert(int index,
                         float position,
                         java.awt.Color color)

Creates the new gradient stop and inserts it at the specified index to the collection.

Specified by:

insert in interface IGradientStopCollection

Parameters:

index - Index in the collection where new gradient stop will be inserted.

position - Position of the new gradient stop.

color - Color of the new radient stop.

insertPresetColor

public final void insertPresetColor(int index,
                                    float position,
                                    int presetColor)

Creates the new gradient stop and inserts it at the specified index to the collection.

Specified by:

insertPresetColor in interface IGradientStopCollection

Parameters:

index - Index in the collection where new gradient stop will be inserted.

position - Position of the new gradient stop.

presetColor - Color of the new radient stop.

insertSchemeColor

public final void insertSchemeColor(int index,
                                    float position,
                                    int schemeColor)

Creates the new gradient stop and inserts it at the specified index to the collection.

Specified by:

insertSchemeColor in interface IGradientStopCollection

Parameters:

index - Index in the collection where new gradient stop will be inserted.

position - Position of the new gradient stop.

schemeColor - Color of the new radient stop.

removeAt

public final void removeAt(int index)

Removes a gradient stop at the specified index.

Specified by:

removeAt in interface IGradientStopCollection

Parameters:

index - Index of a gradient stop that should be deleted.

clear

public final void clear()

Removes all gradient stops from a collection.

Specified by:

clear in interface IGradientStopCollection

iterator

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

Returns an enumerator that iterates through the collection.

Specified by:

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

Specified by:

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

Specified by:

iterator in interface java.lang.Iterable<IGradientStop>

Returns:

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

iteratorJava

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

Returns a java iterator for the entire collection.

Specified by:

iteratorJava in interface IGenericCollection<IGradientStop>

Returns:

An Iterator for the entire collection.

copyTo

public final void copyTo(com.aspose.ms.System.Array array,
                         int index)

Copies all elements from the collection to the specified array.

Specified by:

copyTo in interface com.aspose.ms.System.Collections.ICollection<IGradientStop>

Parameters:

array - Target array.

index - Starting index in the target array.

isSynchronized

public final boolean isSynchronized()

Returns a value indicating whether access to the collection is synchronized (thread-safe). Read-only boolean.

Specified by:

isSynchronized in interface com.aspose.ms.System.Collections.ICollection<IGradientStop>

getSyncRoot

public final java.lang.Object getSyncRoot()

Returns a synchronization root. Read-only Object.

Specified by:

getSyncRoot in interface com.aspose.ms.System.Collections.ICollection<IGradientStop>