ShadingPattern Class Documentation

class ShadingPattern : Pattern

Namespace:com::datalogics::PDFL

Inherits from:
Pattern
Derived classes:
AxialShadingPattern

Detailed Description

A shading pattern consists of a smoothly varying gradient between two colors.

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

finalize

void finalize()

Returns:

void

getAntiAlias

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.

getBackgroundColor

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.

getBoundingBox

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.

getColorSpace

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.

getPDFObject

PDFObject getPDFObject()

Returns:

PDFObject

The PDFObject representing this pattern in the PDF document.

Gets the underlying PDF object for this pattern.

setAntiAlias

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.

setBackgroundColor

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.

setBoundingBox

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.

setColorSpace

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.

toString

String toString()

Returns:

String

A string describing the shading pattern.

Converts the shading pattern to a string representation.