Group Class

class Group : Element

Namespace:com::datalogics::PDFL

Inherits from:: Element

Detailed Description

A set of elements to be used within a PDF document. A Group represents objects in a content object, but it resides in memory.

Therefore the group has no state and is not represented in any way in a PDF content stream. When used in a Clip, a group is used to associate Text objects into a single clipping object.

Referenced by

Group

Uses types

Clip Content Document Group Matrix Rect

Constructor & Destructor Documentation

Group()

Create a new Group.

Group(Content content)

Parameters

content: Content: The new Content of the group.

Create a Group with the given Content.

Member Function Documentation

Group clone()

Returns:

Group

The copied group.

Makes a copy of the group.

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

Group clone(java.util.EnumSet< ElementCloneFlags > cloneFlags)

Parameters

cloneFlags: java.util.EnumSet< ElementCloneFlags >: Flags that modify the cloning operation.

Returns:

Group

The copied group.

Makes a copy of the group.

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

Group colorConvert(Document document, ColorProfile prof, RenderIntent intent, boolean embed)

Parameters

document: Document: The document the element belongs to.
prof: ColorProfile: The ICC ColorProfile to be applied.
intent: RenderIntent: The ICC Rendering Intent for the ColorProfile
embed: boolean: If true, embed the color space and make the object calibrated. If it is false and the target profile is CMYK, RGB, or Gray, the colors space of the resulting objects, after conversion, will be DeviceCMYK, DeviceRGB, or DeviceGray, respectively.

Returns:

Group

A new Group object with the applied ICC ColorProfile.

Applies the specified ICC ColorProfile to the elements in the Group object

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

synchronized void delete()

Returns:

synchronized void

void finalize()

Returns:

void

Rect getBoundingBox()

Returns:

Rect

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.

Clip getClip()

Returns:

Clip

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

Gets the current Clip for an Element.

Content getContent()

Returns:

Content

The Content associated with this Group.

Obtain the content of a Group.

Matrix getMatrix()

Returns:

Matrix

The current transformation matrix applied to this element.

The transformation matrix for the element.

void rotate(double theta)

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 ].

void scale(double sx, double sy)

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 ].

void setClip(Clip clip)

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.

void setContent(Content content)

Parameters

content: Content: The new Content of the group. Must not be null.

Returns:

void

Set the content of a Group.

void setMatrix(Matrix matrix)

Parameters

matrix: Matrix: The transformation matrix for the element.

Returns:

void

Set the transformation matrix for the element.

void translate(double tx, double ty)

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 ].