Element Class

class Element

Namespace:com::datalogics::PDFL

Derived classes:: Container, Form, Group, Image, Path, PostScript, Shading, Text, TextRun

Detailed Description

The base class for elements of the content of a page. An element is a building block; everything in a PDF file is an element. An element object can be associated with a large amount of unmanaged memory in APDFL and should be deleted when the object is no longer in use.

Referenced by

Clip Content Element Form PostScript Shading TextRun

Uses types

Clip Element Matrix Rect

Member Function Documentation

Element clone()

Returns:

Element

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.

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

Parameters

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

Returns:

Element

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.

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.

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