com.aspose.words

Class GradientStopCollection

java.lang.Object

com.aspose.words.GradientStopCollection

All Implemented Interfaces:

java.lang.Iterable

public class GradientStopCollection
extends java.lang.Object
implements java.lang.Iterable

Contains a collection of GradientStop objects. You do not create instances of this class directly. Use the Fill.getGradientStops() property to access gradient stops of fill objects.

Method Summary

Modifier and Type	Method and Description
GradientStop	add(GradientStop gradientStop) Adds a specified GradientStop to a gradient.
GradientStop	get(int index) Gets a GradientStop object in the collection.
int	getCount() Gets an integer value indicating the number of items in the collection.
GradientStop	insert(int index, GradientStop gradientStop) Inserts a GradientStop to the collection at a specified index.
java.util.Iterator	iterator() Returns an enumerator that iterates through the collection.
boolean	remove(GradientStop gradientStop) Removes a specified GradientStop from the collection.
GradientStop	removeAt(int index) Removes a GradientStop from the collection at a specified index.
void	set(int index, GradientStop value) Sets a GradientStop object in the collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

get

public GradientStop get(int index)

Gets a GradientStop object in the collection.

Returns:

A GradientStop object in the collection.

set

public void set(int index,
                GradientStop value)

Sets a GradientStop object in the collection.

Parameters:

value - A GradientStop object in the collection.

insert

public GradientStop insert(int index,
                           GradientStop gradientStop)

Inserts a GradientStop to the collection at a specified index.

add

public GradientStop add(GradientStop gradientStop)

Adds a specified GradientStop to a gradient.

removeAt

public GradientStop removeAt(int index)

Removes a GradientStop from the collection at a specified index.

Returns:

Removed GradientStop.

remove

public boolean remove(GradientStop gradientStop)

Removes a specified GradientStop from the collection.

Returns:

True if gradient stop was successfully removed, otherwise false.

iterator

public java.util.Iterator iterator()

Returns an enumerator that iterates through the collection.

Specified by:

iterator in interface java.lang.Iterable

getCount

public int getCount()

Gets an integer value indicating the number of items in the collection.

Returns:

An integer value indicating the number of items in the collection.