AxialShadingPattern Class

class AxialShadingPattern : ShadingPattern

Namespace: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.

Uses types

Color ColorSpace Function PDFObject Point Rect

Constructor & Destructor Documentation

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

Parameters

colorSpace: ColorSpace: The 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

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

synchronized void delete()

Returns:

synchronized void

void finalize()

Returns:

void

boolean getAntiAlias()

Returns:

boolean

true if anti-aliasing is enabled, false otherwise.

Gets whether anti-aliasing is enabled for the shading. When enabled, the shading function is filtered to prevent aliasing artifacts.

Color getBackgroundColor()

Returns:

Color

The background Color, or NULL if none is set.

Gets the 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.

Rect getBoundingBox()

Returns:

Rect

The bounding box Rect, or NULL if none is set.

Gets the 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.

ColorSpace getColorSpace()

Returns:

ColorSpace

The ColorSpace of the shading pattern.

Gets the color space of a shading pattern. This space is restricted to be any space except a Pattern space.

java.util.List< Point > getCoords()

Returns:

java.util.List< Point >

A list of two Point objects defining the start and end of the axis.

The coordinates of the two endpoints of the axial shading.

java.util.List< Double > getDomain()

Returns:

java.util.List< Double >

A list of two doubles, or null if not set.

The domain of the parametric variable t for the axial shading. An array of two numbers that specify the limiting values of the parametric variable t. This variable t varies linearly between these two values as the gradient varies between the starting and ending points of the axis.

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

java.util.List< Boolean > getExtend()

Returns:

java.util.List< Boolean >

A list of two booleans, or null if not set.

Whether the shading extends beyond the start and end points of the axis. 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.

java.util.List< Function > getFunction()

Returns:

java.util.List< Function >

A list of Function objects used to compute color values.

The function(s) that determine the color channel values for the shading. 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.

PDFObject getPDFObject()

Returns:

PDFObject

The PDFObject representing this pattern in the PDF document.

Gets the underlying PDF object for this pattern.

void setAntiAlias(boolean antiAlias)

Parameters

antiAlias: boolean: true to enable anti-aliasing, false to disable it.

Returns:

void

Sets whether anti-aliasing is enabled for the shading. When enabled, the shading function is filtered to prevent aliasing artifacts.

void setBackgroundColor(Color color)

Parameters

color: Color: The background Color to set, or NULL to remove it.

Returns:

void

Sets the 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. Set to NULL to remove the background color.

void setBoundingBox(Rect boundingBox)

Parameters

boundingBox: Rect: The bounding box Rect to set, or NULL to remove it.

Returns:

void

Sets the 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. Set to NULL to remove the bounding box.

void setColorSpace(ColorSpace colorSpace)

Parameters

colorSpace: ColorSpace: The ColorSpace to set for the shading pattern.

Returns:

void

Sets the color space of a shading pattern. This space is restricted to be any space except a Pattern space.

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

Parameters

coords: java.util.List< Point >: A list of exactly two Point objects defining the start and end of the axis.

Returns:

void

Set the coordinates of the two endpoints of the axial shading.

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

Parameters

domain: java.util.List< Double >: A list of exactly two doubles, or null to remove.

Returns:

void

Set the domain of the parametric variable t for the axial shading. An array of two numbers that specify the limiting values of the parametric variable t. This variable t varies linearly between these two values as the gradient varies between the starting and ending points of the axis.

Default value: [0, 1]. Pass NULL to remove the domain entry.

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

Parameters

extend: java.util.List< Boolean >: A list of exactly two booleans, or null to remove.

Returns:

void

Set whether the shading extends beyond the start and end points of the axis. 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]. Pass NULL to remove the extend entry.

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

Parameters

function: java.util.List< Function >: A list of one or more Function objects. Must contain at least one function.

Returns:

void

Set the function(s) that determine the color channel values for the shading. 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.

String toString()

Returns:

String

A formatted string describing this AxialShadingPattern.

Return a string representation of the AxialShadingPattern. The string includes the color space, background color, bounding box, anti-alias flag, coordinates, function, domain, and extend values.