ShadingPattern Class Documentation
classShadingPattern : PatternNamespace:com::datalogics::PDFL
- Inherits from:
Pattern
- Derived classes:
- AxialShadingPattern
Detailed Description
A shading pattern consists of a smoothly varying gradient between two colors.
Uses types
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:
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
ColorgetBackgroundColor()Returns:
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
RectgetBoundingBox()Returns:
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
ColorSpacegetColorSpace()Returns:
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
PDFObjectgetPDFObject()Returns:
The PDFObject representing this pattern in the PDF document.Gets the underlying PDF object for this pattern.
setAntiAlias
voidsetAntiAlias(booleanantiAlias)Parameters
antiAlias: booleantrue to enable anti-aliasing, false to disable it.
Returns:
voidSets whether anti-aliasing is enabled for the shading. When enabled, the shading function is filtered to prevent aliasing artifacts.
setBackgroundColor
voidsetBackgroundColor(Colorcolor)Parameters
color: ColorThe background Color to set, or NULL to remove it.
Returns:
voidSets 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
voidsetBoundingBox(RectboundingBox)Parameters
boundingBox: RectThe bounding box Rect to set, or NULL to remove it.
Returns:
voidSets 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
voidsetColorSpace(ColorSpacecolorSpace)Parameters
colorSpace: ColorSpaceThe ColorSpace to set for the shading pattern.
Returns:
voidSets the color space of a shading pattern. This space is restricted to be any space except a Pattern space.
toString
StringtoString()Returns:
A string describing the shading pattern.Converts the shading pattern to a string representation.