Form Class Documentation

class Form : Element

Namespace:com::datalogics::PDFL

Inherits from:
Element

Detailed Description

Represents a PDF form XObject. This is not to be confused with a PDF fillable form; a Form XObject is an object outside the page content stream.

A form XObject is a way to group a number of PDF objects together, into a single container. A Form XObject can hold both text and images, and can be defined once within a PDF file and then reused multiple times in the same PDF, and across multiple pages.

Referenced by

AnnotationCircleAnnotationFormFreeTextAnnotationHighlightAnnotationInkAnnotationLineAnnotationLinkAnnotationOCREnginePolyLineAnnotationPolygonAnnotationRedactionSquareAnnotationTextMarkupAnnotationUnderlineAnnotation

Constructor & Destructor Documentation

Form

Form(Content content, Document document)

Parameters

content: Content

The content from which to create the form

document: Document

the document in which the image is intended to be used.

Create a form with the given Content.

Specifying the document optimizes data usage for this image within that document.

Member Function Documentation

clone

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.

clone

Form clone()

Returns:

Form

The newly created form object.

Creates a new form from an existing form object. Creates a copy of the Form, including the underlying Content.

colorConvert

Form 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 objects 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:

Form

A new Form with the applied ICC ColorProfile.

Applies the specified ICC ColorProfile to the objects in the form

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

finalize

void finalize()

Returns:

void

getBoundingBox

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.

getClip

Clip getClip()

Returns:

Clip

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

Gets the current Clip for an Element.

getContent

Content getContent()

Returns:

Content

The Content of the form.

The Content contained in the form. Returns the content associated with this form XObject.

getGraphicState

GraphicState getGraphicState()

Returns:

GraphicState

The GraphicState of this Form, or null if none is set.

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

getMatrix

Matrix getMatrix()

Returns:

Matrix

The current transformation matrix applied to this element.

The transformation matrix for the element.

getOptionalContentMembershipDict

OptionalContentMembershipDict getOptionalContentMembershipDict()

Returns:

OptionalContentMembershipDict

the OptionalContentMembershipDict

The OptionalContentMembershipDict property for this Form.

Setting this property will attach the Form to an OptionalContentMembershipDict; it will then be associated with the OptionalContentGroups and be subject to the VisibilityPolicy and VisibilityExpression of that MembershipDict.

By setting this property to null, the Form is detached from any OptionalContentMembershipDict.

getStream

PDFStream getStream()

Returns:

PDFStream

The stream associated with the form.

Get the stream associated with the form. Returns the underlying PDF stream (COS object) for this form XObject.

isCurrentlyVisible

boolean isCurrentlyVisible(OptionalContentContext occ)

Parameters

occ: OptionalContentContext

The optional content context to use for visibility state information.

Returns:

boolean

true if the form is currently visible.

Tests whether a form is visible in a given optional content context, considering the current ON-OFF states of the optional-content groups in the optional-content dictionary (OCMD) and the dictionary's visibility policy.

If the form occurs more than once within the content, this method only checks the visibility of the first occurrence of the form.

This method determines visibility without considering the visbility of the Content object that the form belongs to. To determine the visibility of a form while taking the Content's visibility into consideration, use the alternate version of this method.

isCurrentlyVisible

boolean isCurrentlyVisible(OptionalContentContext occ, Content content)

Parameters

occ: OptionalContentContext

The optional content context to use for visibility state information.

content: Content

The content containing the form, used to also consider the Content's own visibility.

Returns:

boolean

true if the form is currently visible.

Tests whether a form is visible in a given optional content context and content.

If the form occurs more than once within the content, this method only checks the visibility of the first occurrence of the form.

makeVisible

boolean makeVisible(OptionalContentContext occ, Content content)

Parameters

occ: OptionalContentContext

The optional content context in which the form is made visible.

content: Content

The content containing the form.

Returns:

boolean

true if the form is successfully made visible in the given context and content, false otherwise

Makes a form visible in a given optional content context and content by manipulating the ON-OFF states of the optional content groups.

rotate

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

scale

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

setClip

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.

setContent

void setContent(Content content)

Parameters

content: Content

The new content for the form.

Returns:

void

Set the Content of the form. Setting new content also dynamically recalculates the form's bounding box.

setGraphicState

void setGraphicState(GraphicState gstate)

Parameters

gstate: GraphicState

The new/updated Graphic State for the Form.

Returns:

void

Set the Graphic State of this Form.

setMatrix

void setMatrix(Matrix matrix)

Parameters

matrix: Matrix

The transformation matrix for the element.

Returns:

void

Set the transformation matrix for the element.

setOptionalContentMembershipDict

void setOptionalContentMembershipDict(OptionalContentMembershipDict ocmd)

Parameters

ocmd: OptionalContentMembershipDict

the OptionalContentMembershipDict

Returns:

void

The OptionalContentMembershipDict property for this Form.

Setting this property will attach the Form to an OptionalContentMembershipDict; it will then be associated with the OptionalContentGroups and be subject to the VisibilityPolicy and VisibilityExpression of that MembershipDict.

By setting this property to null, the Form is detached from any OptionalContentMembershipDict.

translate

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