Shading Class Documentation

classShading : Element

Namespace:com::datalogics::PDFL

Inherits from:
Element

Detailed Description

Represents a region shaded with color, as defined by a shading dictionary. A shading pattern defines a gradient fill in a graphic that produces a smooth transition between colors across the area covered by the graphic area. The "sh" paint operator is invoked for the shading object. This does not correspond to a shading dictionary within a PDF pattern. Refer to the Pattern object for shading dictionaries used in PDF patterns.

A shading pattern defines a gradient fill in a graphic that produces a smooth transition between colors across the area covered by the graphic area. The "sh" paint operator is invoked for the shading object. This does not correspond to a shading dictionary within a PDF pattern. Refer to the Pattern object for shading dictionaries used in PDF patterns.

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

clone

Elementclone()

Returns:

The copied element.

Makes a copy of the element.

Make a copy of an element to obtain a new element that has a distinct set of attributes.

Note: TextRun objects may not be cloned.

clone

Elementclone(java.util.EnumSet< ElementCloneFlags >cloneFlags)

Parameters

cloneFlags: java.util.EnumSet< ElementCloneFlags >

Flags that modify the cloning operation.

Returns:

The copied element.

Makes a copy of the element.

Make a copy of an element to obtain a new element that has a distinct set of attributes.

Note: TextRun objects may not be cloned.

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

finalize

voidfinalize()

Returns:

void

getBoundingBox

RectgetBoundingBox()

Returns:

The bounding box for this element. The coordinates of the bounding box are specified in user space coordinates, relative to the element's Content. Note that user space coordinates correspond to unrotated pages; any rotation specified in the page dictionary is not taken into account.

The bounding box for this element. The bounding box is a rectangle that is guaranteed to encompass the element, but it is not guaranteed to be the smallest box that could contain the element. For example, if the element is a Path that contains an arc, the bounding box encompasses the bezier control points, and not just the curve itself.

getClip

ClipgetClip()

Returns:

The current Clip for this Element, or NULL if no clip is set.

Gets the current Clip for an Element.

getColorSpace

ColorSpacegetColorSpace()

Returns:

The ColorSpace associated with this Shading, obtained from the shading dictionary.

Get the ColorSpace of the current Shading object.

getGraphicState

GraphicStategetGraphicState()

Returns:

The GraphicState for this Shading, or NULL if none is set.

Get the graphic state of the current Shading object. May return null if this element does not have a GraphicState.

getMatrix

MatrixgetMatrix()

Returns:

The current transformation matrix applied to this element.

The transformation matrix for the element.

rotate

voidrotate(doubletheta)

Parameters

theta: double

The rotation angle in degrees.

Returns:

void

Rotate an element by theta degrees counterclockwise using the matrix [ cos T sin T -sin T cos T 0 0 ].

scale

voidscale(doublesx, doublesy)

Parameters

sx: double

The horizontal scale factor.

sy: double

The vertical scale factor.

Returns:

void

Scale an element by (sx,sy) units using the matrix [ sx 0 0 sy 0 0 ].

setClip

voidsetClip(Clipclip)

Parameters

clip: Clip

The clip to set as the current clip for this element, or NULL to remove clipping.

Returns:

void

Sets the current Clip for an Element.

setMatrix

voidsetMatrix(Matrixmatrix)

Parameters

matrix: Matrix

The transformation matrix for the element.

Returns:

void

Set the transformation matrix for the element.

translate

voidtranslate(doubletx, doublety)

Parameters

tx: double

The horizontal translation distance in user space units.

ty: double

The vertical translation distance in user space units.

Returns:

void

Translate an element by (tx,ty) units using the matrix [ 1 0 0 1 tx ty ].