Clip Class Documentation

classClip

Namespace:com::datalogics::PDFL

Detailed Description

A clipping path is used to mark an area within a page to be highlighted or removed. The clipping path clips out part of the design. A clip can also be used with text.

The clipping path defines an area within a page (text or graphic) that will be highlighted or removed. For example, a clipping path could be used to remove the background in a photograph, to highlight a person or object in front, or to super-impose text over an image. Only part of the image appears through a shape created with the clipping path.

The Clip class is made up of a list of path and text elements. Any element can have a clip associated with it, and clip objects can hold arbitrary levels of nested container and group objects.

If a group object is inside a clip object, and the clip object also contains at least one text object and no path objects, the group object has a special meaning. All text objects contained in a group object like this are considered to be part of the same BT/ET block. This means that the union of these text objects makes up a single clipping path. The text objects do not intersect.

Referenced by

ClipContainerElementFormGroupImagePathPostScriptShadingTextTextRun

Uses types

ClipElement

Constructor & Destructor Documentation

Clip

Clip()

Creates an empty Clip object. This represents a clipping object that has no effect on elements that refer to it.

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

addElement

voidaddElement(Elementelement)

Parameters

element: Element

The Element to add to the Clip.

Returns:

void

Adds an Element to a Clip path as the first indexed Element.

addElement

voidaddElement(Elementelement, intaddAfterIndex)

Parameters

element: Element

The Element to add to the Clip.

addAfterIndex: int

The index after which this Element will be added to the Clip's list of Elements. If omitted, it will be added as index 0, i.e., the first Element.

Returns:

void

Adds an Element to a Clip path, after the Element index specified.

clone

Clipclone()

Returns:

A new clip object deep copy

Makes a new deep copy of this Clip object in memory.

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

finalize

voidfinalize()

Returns:

void

getElement

ElementgetElement(intindex)

Parameters

index: int

The index of the desired Element.

Returns:

- The Element found at the supplied index in the Clip's Element list.

Gets an Element from a Clip path.

numElements

intnumElements()

Returns:

- The number of top-level Elements in the Clip.

Gets the number of top-level Elements in a Clip object.

removeElements

voidremoveElements(intindex)

Parameters

index: int

The index of the Element to remove.

Returns:

void

Removes an Element from a Clip object.

removeElements

voidremoveElements(intindex, intcount)

Parameters

index: int

The index of the first Element to remove.

count: int

The number of Elements to remove, starting with the index Element.

Returns:

void

Removes one or more Elements from a Clip object.

toString

StringtoString()

Returns:

String