com.aspose.psd.fileformats.psd.layers.fillsettings

Class GradientFillSettings

java.lang.Object

com.aspose.psd.fileformats.psd.layers.fillsettings.BaseFillSettings

com.aspose.psd.fileformats.psd.layers.fillsettings.GradientFillSettings

All Implemented Interfaces:

IFillSettings, IGradientFillSettings

public class GradientFillSettings
extends BaseFillSettings
implements IGradientFillSettings

Gradient fill effect settings.

See Also:

BaseFillSettings

Constructor Summary

Constructors

Constructor and Description
GradientFillSettings() Initializes a new instance of the GradientFillSettings class.

Method Summary

Modifier and Type	Method and Description
GradientColorPoint	addColorPoint() Adds the color point.
GradientTransparencyPoint	addTransparencyPoint() Adds the color point.
static List<OSTypeStructure>	generateLfx2ResourceNodes() Generates the LFX2 resource nodes.
boolean	getAlignWithLayer() Gets or sets a value indicating whether [align with layer].
double	getAngle() Gets or sets the angle.
Color	getColor() Gets or sets the color.
IGradientColorPoint[]	getColorPoints() Gets or sets the color points.
boolean	getDither() Gets or sets a value indicating whether this GradientFillSettings is dither.
int	getFillType() The fill type
String	getGradientName() Gets or sets the name of the gradient.
int	getGradientType() Gets or sets the type of the gradient.
double	getHorizontalOffset() Gets or sets the horizontal offset.
boolean	getReverse() Gets or sets a value indicating whether this GradientFillSettings is reverse.
int	getScale() Gets or sets the scale.
IGradientTransparencyPoint[]	getTransparencyPoints() Gets or sets the transparency points.
double	getVerticalOffset() Gets or sets the vertical offset.
void	removeColorPoint(IGradientColorPoint point) Removes the color point.
void	removeTransparencyPoint(IGradientTransparencyPoint point) Removes the transparency point.
void	setAlignWithLayer(boolean value) Gets or sets a value indicating whether [align with layer].
void	setAngle(double value) Gets or sets the angle.
void	setColor(Color value) Gets or sets the color.
void	setColorPoints(IGradientColorPoint[] value) Gets or sets the color points.
void	setDither(boolean value) Gets or sets a value indicating whether this GradientFillSettings is dither.
void	setGradientName(String value) Gets or sets the name of the gradient.
void	setGradientType(int value) Gets or sets the type of the gradient.
void	setHorizontalOffset(double value) Gets or sets the horizontal offset.
void	setReverse(boolean value) Gets or sets a value indicating whether this GradientFillSettings is reverse.
void	setScale(int value) Gets or sets the scale.
void	setTransparencyPoints(IGradientTransparencyPoint[] value) Gets or sets the transparency points.
void	setVerticalOffset(double value) Gets or sets the vertical offset.

Constructor Detail

GradientFillSettings

public GradientFillSettings()

Initializes a new instance of the GradientFillSettings class.

Method Detail

getColor

public final Color getColor()

Gets or sets the color.

Value: The color.

Specified by:

getColor in interface IGradientFillSettings

setColor

public final void setColor(Color value)

Gets or sets the color.

Value: The color.

Specified by:

setColor in interface IGradientFillSettings

getAlignWithLayer

public final boolean getAlignWithLayer()

Gets or sets a value indicating whether [align with layer].

Value: true if [align with layer]; otherwise, false.

Specified by:

getAlignWithLayer in interface IGradientFillSettings

setAlignWithLayer

public final void setAlignWithLayer(boolean value)

Gets or sets a value indicating whether [align with layer].

Value: true if [align with layer]; otherwise, false.

Specified by:

setAlignWithLayer in interface IGradientFillSettings

getDither

public final boolean getDither()

Gets or sets a value indicating whether this GradientFillSettings is dither.

Value: true if dither; otherwise, false.

Specified by:

getDither in interface IGradientFillSettings

setDither

public final void setDither(boolean value)

Gets or sets a value indicating whether this GradientFillSettings is dither.

Value: true if dither; otherwise, false.

Specified by:

setDither in interface IGradientFillSettings

getReverse

public final boolean getReverse()

Gets or sets a value indicating whether this GradientFillSettings is reverse.

Value: true if reverse; otherwise, false.

Specified by:

getReverse in interface IGradientFillSettings

setReverse

public final void setReverse(boolean value)

Gets or sets a value indicating whether this GradientFillSettings is reverse.

Value: true if reverse; otherwise, false.

Specified by:

setReverse in interface IGradientFillSettings

getAngle

public final double getAngle()

Gets or sets the angle.

Specified by:

getAngle in interface IGradientFillSettings

Throws:

PsdImageArgumentException - Angle must be in range from -180.0 to 180.0 Value: The angle.

setAngle

public final void setAngle(double value)

Gets or sets the angle.

Specified by:

setAngle in interface IGradientFillSettings

Throws:

PsdImageArgumentException - Angle must be in range from -180.0 to 180.0 Value: The angle.

getScale

public final int getScale()

Gets or sets the scale.

Specified by:

getScale in interface IGradientFillSettings

Throws:

PsdImageArgumentException - Scale must be in range from 1 to 1000. Value: The scale.

setScale

public final void setScale(int value)

Gets or sets the scale.

Specified by:

setScale in interface IGradientFillSettings

Throws:

PsdImageArgumentException - Scale must be in range from 1 to 1000. Value: The scale.

getGradientType

public final int getGradientType()

Gets or sets the type of the gradient.

Value: The type of the gradient.

Specified by:

getGradientType in interface IGradientFillSettings

setGradientType

public final void setGradientType(int value)

Gets or sets the type of the gradient.

Value: The type of the gradient.

Specified by:

setGradientType in interface IGradientFillSettings

getGradientName

public final String getGradientName()

Gets or sets the name of the gradient.

Value: The name of the gradient.

Specified by:

getGradientName in interface IGradientFillSettings

setGradientName

public final void setGradientName(String value)

Gets or sets the name of the gradient.

Value: The name of the gradient.

Specified by:

setGradientName in interface IGradientFillSettings

getHorizontalOffset

public final double getHorizontalOffset()

Gets or sets the horizontal offset.

Value: The horizontal offset.

Specified by:

getHorizontalOffset in interface IGradientFillSettings

setHorizontalOffset

public final void setHorizontalOffset(double value)

Gets or sets the horizontal offset.

Value: The horizontal offset.

Specified by:

setHorizontalOffset in interface IGradientFillSettings

getVerticalOffset

public final double getVerticalOffset()

Gets or sets the vertical offset.

Value: The vertical offset.

Specified by:

getVerticalOffset in interface IGradientFillSettings

setVerticalOffset

public final void setVerticalOffset(double value)

Gets or sets the vertical offset.

Value: The vertical offset.

Specified by:

setVerticalOffset in interface IGradientFillSettings

getFillType

public int getFillType()

The fill type

Specified by:

getFillType in interface IFillSettings

Specified by:

getFillType in class BaseFillSettings

getColorPoints

public final IGradientColorPoint[] getColorPoints()

Gets or sets the color points.

Value: The color points.

Specified by:

getColorPoints in interface IGradientFillSettings

setColorPoints

public final void setColorPoints(IGradientColorPoint[] value)

Gets or sets the color points.

Value: The color points.

Specified by:

setColorPoints in interface IGradientFillSettings

getTransparencyPoints

public final IGradientTransparencyPoint[] getTransparencyPoints()

Gets or sets the transparency points.

Value: The transparency points.

Specified by:

getTransparencyPoints in interface IGradientFillSettings

setTransparencyPoints

public final void setTransparencyPoints(IGradientTransparencyPoint[] value)

Gets or sets the transparency points.

Value: The transparency points.

Specified by:

setTransparencyPoints in interface IGradientFillSettings

generateLfx2ResourceNodes

public static List<OSTypeStructure> generateLfx2ResourceNodes()

Generates the LFX2 resource nodes.

Returns:

Generated List of OSTypeStructure

addColorPoint

public final GradientColorPoint addColorPoint()

Adds the color point.

Returns:

Created color point

addTransparencyPoint

public final GradientTransparencyPoint addTransparencyPoint()

Adds the color point.

Returns:

Created transparency point

removeTransparencyPoint

public final void removeTransparencyPoint(IGradientTransparencyPoint point)

Removes the transparency point.

Parameters:

point - The point.

removeColorPoint

public final void removeColorPoint(IGradientColorPoint point)

Removes the color point.

Parameters:

point - The point.