AxialShadingPattern Class Documentation
classAxialShadingPattern : ShadingPatternNamespace:com::datalogics::PDFL
- Inherits from:
ShadingPattern
Detailed Description
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 & Destructor Documentation
AxialShadingPattern
AxialShadingPattern(ColorSpacecolorSpace, java.util.List< Point >coords, java.util.List< Function >function)Parameters
colorSpace: ColorSpaceThe color space for the pattern.
coords: java.util.List< Point >The coordinates of the two endpoints of the axial shading.
function: java.util.List< 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.
Create an AxialShadingPattern.
Member Function Documentation
DisposeChildren
voidDisposeChildren()Returns:
void[static initializer]
static void[static initializer]()delete
synchronized voiddelete(Booleandisposing)Parameters
disposing: Boolean
Returns:
synchronized voiddelete
synchronized voiddelete()Returns:
synchronized voidfinalize
voidfinalize()Returns:
voidgetAntiAlias
booleangetAntiAlias()Returns:
booleanA flag indicating whether to filter the shading function to prevent aliasing artifacts.
getBackgroundColor
ColorgetBackgroundColor()Returns:
ColorThe background color of the shading pattern. This color must be in the color space of the shading pattern. If present, it is used to fill the areas that are outside the bounds of the shading object. May be NULL.
getBoundingBox
RectgetBoundingBox()Returns:
RectThe bounding box of the shading. The coordinates are interpreted in the target coordinate space. If present, provides an additional, temporary clipping boundary to the shading.
getColorSpace
ColorSpacegetColorSpace()Returns:
ColorSpaceThe color space of a shading pattern. This space is restricted to be any space except a Pattern space.
getCoords
java.util.List< Point >getCoords()Returns:
java.util.List< Point >The coordinates of the two endpoints of the axial shading.
getDomain
java.util.List< Double >getDomain()Returns:
java.util.List< Double >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.
getExtend
java.util.List< Boolean >getExtend()Returns:
java.util.List< Boolean >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.
getFunction
java.util.List< Function >getFunction()Returns:
java.util.List< 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.
getPDFObject
PDFObjectgetPDFObject()Returns:
PDFObjectsetAntiAlias
voidsetAntiAlias(booleanantiAlias)Parameters
antiAlias: boolean
Returns:
voidA flag indicating whether to filter the shading function to prevent aliasing artifacts.
setBackgroundColor
voidsetBackgroundColor(Colorcolor)Parameters
color: Color
Returns:
voidThe background color of the shading pattern. This color must be in the color space of the shading pattern. If present, it is used to fill the areas that are outside the bounds of the shading object. May be NULL.
setBoundingBox
voidsetBoundingBox(RectboundingBox)Parameters
boundingBox: Rect
Returns:
voidThe bounding box of the shading. The coordinates are interpreted in the target coordinate space. If present, provides an additional, temporary clipping boundary to the shading.
setColorSpace
voidsetColorSpace(ColorSpacecolorSpace)Parameters
colorSpace: ColorSpace
Returns:
voidThe color space of a shading pattern. This space is restricted to be any space except a Pattern space.
setCoords
voidsetCoords(java.util.List< Point >coords)Parameters
coords: java.util.List< Point >
Returns:
voidThe coordinates of the two endpoints of the axial shading.
setDomain
voidsetDomain(java.util.List< Double >domain)Parameters
domain: java.util.List< Double >
Returns:
voidA 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.
setExtend
voidsetExtend(java.util.List< Boolean >extend)Parameters
extend: java.util.List< Boolean >
Returns:
voidAn 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.
setFunction
voidsetFunction(java.util.List< Function >function)Parameters
function: java.util.List< Function >
Returns:
voidOne 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.
toString
StringtoString()Returns:
StringReturn a string representation of the AxialShadingPattern.