com.datalogics.PDFL

Class Element

java.lang.Object

com.datalogics.PDFL.Element

Direct Known Subclasses:

Container, Form, Group, Image, Path, PostScript, Shading, Text, TextRun

public class Element
extends java.lang.Object

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.

Method Summary

Modifier and Type	Method and Description
Element	clone() Makes a copy of the element.
Element	clone(java.util.EnumSet<ElementCloneFlags> cloneFlags) Makes a copy of the element.
void	delete()
Rect	getBoundingBox() The bounding box for this element.
Clip	getClip() Gets the current Clip for an Element.
Matrix	getMatrix() The transformation matrix for the element.
void	rotate(double theta) Rotate an element by T degrees counterclockwise units using the matrix [ cos T sin T -sin T cos T 0 0 ].
void	scale(double sx, double sy) Scale an element by (sx,sy) units using the matrix [ sx 0 0 sy 0 0 ].
void	setClip(Clip clip) Sets the current Clip for an Element.
void	setMatrix(Matrix matrix) Set the transformation matrix for the element.
void	translate(double tx, double ty) Translate an element by (tx,ty) units using the matrix [ 1 0 0 1 tx ty ].

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

delete

public void delete()

getMatrix

public Matrix getMatrix()

The transformation matrix for the element.

setMatrix

public void setMatrix(Matrix matrix)

Set the transformation matrix for the element.

Parameters:

matrix - the transformation matrix for the element.

translate

public void translate(double tx,
                      double ty)

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

rotate

public void rotate(double theta)

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

scale

public void scale(double sx,
                  double sy)

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

setClip

public void setClip(Clip clip)

Sets the current Clip for an Element.

Parameters:

clip - The clip to set as the current clip for this element.

getClip

public Clip getClip()

Gets the current Clip for an Element.

Returns:

- The current Clip for this Element.

clone

public Element clone()

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.

Overrides:

clone in class java.lang.Object

Returns:

The copied element.

clone

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

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.

Parameters:

cloneFlags - Flags that modify the cloning operation.

Returns:

The copied element.

getBoundingBox

public Rect getBoundingBox()

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.

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.