com.datalogics.PDFL

Class AxialShadingPattern

java.lang.Object

com.datalogics.PDFL.Pattern

com.datalogics.PDFL.ShadingPattern

com.datalogics.PDFL.AxialShadingPattern

public class AxialShadingPattern
extends ShadingPattern

A color blend that varies along an axis. An axial shading specifies a color blend that varies along a linear axis between two endpoints, and indefinitely perpendicular to that axis.

Constructor Summary

Constructors

Constructor and Description
AxialShadingPattern(ColorSpace colorSpace, java.util.List<Point> coords, java.util.List<Function> function) Create an AxialShadingPattern.

Method Summary

Modifier and Type	Method and Description
void	delete()
java.util.List<Point>	getCoords() The coordinates of the two endpoints of the axial shading.
java.util.List<java.lang.Double>	getDomain() A array of two numbers that specify the limiting values of the parametric variable t.
java.util.List<java.lang.Boolean>	getExtend() An array of two boolean values indicating whether to extend the shading beyond the starting and ending points of the axis, respectively.
java.util.List<Function>	getFunction() One 1-in n-out function, or an array of n 1-in 1-out functions that determine the values of the color channels, where n is the number of color components in the shading's color space.
void	setCoords(java.util.List<Point> coords) The coordinates of the two endpoints of the axial shading.
void	setDomain(java.util.List<java.lang.Double> domain) A array of two numbers that specify the limiting values of the parametric variable t.
void	setExtend(java.util.List<java.lang.Boolean> extend) An array of two boolean values indicating whether to extend the shading beyond the starting and ending points of the axis, respectively.
void	setFunction(java.util.List<Function> function) One 1-in n-out function, or an array of n 1-in 1-out functions that determine the values of the color channels, where n is the number of color components in the shading's color space.
java.lang.String	toString() Return a string representation of the AxialShadingPattern.

Methods inherited from class com.datalogics.PDFL.ShadingPattern

getAntiAlias, getBackgroundColor, getBoundingBox, getColorSpace, setAntiAlias, setBackgroundColor, setBoundingBox, setColorSpace

Methods inherited from class com.datalogics.PDFL.Pattern

getPDFObject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AxialShadingPattern

public AxialShadingPattern(ColorSpace colorSpace,
                           java.util.List<Point> coords,
                           java.util.List<Function> function)

Create an AxialShadingPattern.

Parameters:

colorSpace - The color space for the pattern.

coords - The coordinates of the two endpoints of the axial shading.

function - One 1-in n-out function, or an array of n 1-in 1-out functions that determine the values of the color channels.

Method Detail

delete

public void delete()

Overrides:

delete in class ShadingPattern

toString

public java.lang.String toString()

Return a string representation of the AxialShadingPattern.

Overrides:

toString in class ShadingPattern

getCoords

public java.util.List<Point> getCoords()

The coordinates of the two endpoints of the axial shading.

setCoords

public void setCoords(java.util.List<Point> coords)

The coordinates of the two endpoints of the axial shading.

getFunction

public java.util.List<Function> getFunction()

One 1-in n-out function, or an array of n 1-in 1-out functions that determine the values of the color channels, where n is the number of color components in the shading's color space. The functions are called with a parametric variable t which varies across the Domain.

setFunction

public void setFunction(java.util.List<Function> function)

One 1-in n-out function, or an array of n 1-in 1-out functions that determine the values of the color channels, where n is the number of color components in the shading's color space. The functions are called with a parametric variable t which varies across the Domain.

getDomain

public java.util.List<java.lang.Double> getDomain()

A array of two numbers that specify the limiting values of the parametric variable t. This variable t varies linearly between these two values as a the gradient varies between the starting and ending points of the axis.

Defaults to [0, 1]. May be NULL.

setDomain

public void setDomain(java.util.List<java.lang.Double> domain)

A array of two numbers that specify the limiting values of the parametric variable t. This variable t varies linearly between these two values as a the gradient varies between the starting and ending points of the axis.

Defaults value: [0, 1]. May be NULL.

getExtend

public java.util.List<java.lang.Boolean> getExtend()

An array of two boolean values indicating whether to extend the shading beyond the starting and ending points of the axis, respectively.

Default value: [false, false]. May be NULL.

setExtend

public void setExtend(java.util.List<java.lang.Boolean> extend)

An array of two boolean values indicating whether to extend the shading beyond the starting and ending points of the axis, respectively.

Default value: [false, false]. May be NULL.