com.grapecity.documents.excel.drawing

Interface IGradientStops

All Superinterfaces:

java.lang.Iterable<IGradientStop>

public interface IGradientStops
extends java.lang.Iterable<IGradientStop>

Represents a collection of IGradientStop objects.

Method Summary

Modifier and Type	Method and Description
void	delete(int index) Removes a gradient stop.
IGradientStop	get(int index) Gets the IGradientStop object from the IGradientStops collection.
int	getCount() Gets the number of items in the IGradientStops collection.
void	insert(int rgb, double position) Adds a stop to a gradient and specifies the brightness, as well as the transparency of the color.
void	insert(int rgb, double position, double transparency, int index, double brightness) Adds a stop to a gradient and specifies the brightness, as well as the transparency of the color.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getCount

int getCount()

Gets the number of items in the IGradientStops collection.

get

IGradientStop get(int index)

Gets the IGradientStop object from the IGradientStops collection.

Parameters:

index - The name or index number of the returned object.

delete

void delete(int index)

Removes a gradient stop.

Parameters:

index - The index number of the gradient stop.

insert

void insert(int rgb,
            double position)

Adds a stop to a gradient and specifies the brightness, as well as the transparency of the color.

Parameters:

rgb - Specifies the color at the gradient stop.

position - Specifies the position of the stop within the gradient expressed as a percent.

insert

void insert(int rgb,
            double position,
            double transparency,
            int index,
            double brightness)

Adds a stop to a gradient and specifies the brightness, as well as the transparency of the color.

Parameters:

rgb - Specifies the color at the gradient stop.

position - Specifies the position of the stop within the gradient expressed as a percent.

transparency - Specifies the opacity of color at the gradient stop.

index - The index number of the stop.

brightness - Specifies the brightness of the color at the gradient stop.