com.mindoo.remote.api.symphony.presentation
Interface IRemoteFillGradient

public interface IRemoteFillGradient

This class describes a color dispersion within an area.

Access

To get the fill gradient of a shape, use the Gradient property in the FillFormat class.

Usage

See the Gradient property in the FillFormat class for descriptions and examples.

Method Summary

int	getAngle() This property returns the angle of the gradient image in 1/100 degree.
int	getBeginColor() This property returns the color at the starting point of the gradient image.
int	getBeginIntensity() This property returns the intensity at the starting point of the gradient image.
short	getBorder() This property returns percent age of the total width where the start color is used.
short	getCenterX() This property returns the x-coordinate that specifies where the gradient image begins.
short	getCenterY() This property returns the y-coordinate that specifies where the gradient image begins.
int	getEndColor() This property returns the color at the endpoint of the gradient image.
int	getEndIntensity() This property returns the intensity at the endpoint of the gradient image.
int	getGradientType() This property returns the type of the gradient image.

Method Detail

getGradientType

int getGradientType()
                    throws RemoteEclipseAPIException

This property returns the type of the gradient image.

Legal value

• FillFormat.FILLFORMAT_GRADIENTTYPE_LINEAR specifies a linear gradient image.
• FillFormat.FILLFORMAT_GRADIENTTYPE_AXIAL specifies an axial gradient image.
• FillFormat.FILLFORMAT_GRADIENTTYPE_RADIAL specifies a radial gradient image.
• FillFormat.FILLFORMAT_GRADIENTTYPE_ELLIPTICAL specifies an elliptical gradient image.
• FillFormat.FILLFORMAT_GRADIENTTYPE_SQUARE specifies a gradient image in the shape of a square.
• FillFormat.FILLFORMAT_GRADIENTTYPE_RECT specifies a gradient image in the shape of a rectangle.

Returns:

type

Throws:

RemoteEclipseAPIException

getBeginColor

int getBeginColor()
                  throws RemoteEclipseAPIException

This property returns the color at the starting point of the gradient image.

Returns:

color

Throws:

RemoteEclipseAPIException

getEndColor

int getEndColor()
                throws RemoteEclipseAPIException

This property returns the color at the endpoint of the gradient image.

Returns:

color

Throws:

RemoteEclipseAPIException

getAngle

int getAngle()
             throws RemoteEclipseAPIException

This property returns the angle of the gradient image in 1/100 degree.

Returns:

angle

Throws:

RemoteEclipseAPIException

getBorder

short getBorder()
                throws RemoteEclipseAPIException

This property returns percent age of the total width where the start color is used.

Returns:

border

Throws:

RemoteEclipseAPIException

getBeginIntensity

int getBeginIntensity()
                      throws RemoteEclipseAPIException

This property returns the intensity at the starting point of the gradient image.

Returns:

intensity

Throws:

RemoteEclipseAPIException

getEndIntensity

int getEndIntensity()
                    throws RemoteEclipseAPIException

This property returns the intensity at the endpoint of the gradient image.

Returns:

intensity

Throws:

RemoteEclipseAPIException

getCenterX

short getCenterX()
                 throws RemoteEclipseAPIException

This property returns the x-coordinate that specifies where the gradient image begins.

Returns:

x

Throws:

RemoteEclipseAPIException

getCenterY

short getCenterY()
                 throws RemoteEclipseAPIException

This property returns the y-coordinate that specifies where the gradient image begins.

Returns:

y

Throws:

RemoteEclipseAPIException