com.datalogics.PDFL

Class Form

java.lang.Object

com.datalogics.PDFL.Element

com.datalogics.PDFL.Form

public class Form
extends Element

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.

Constructor Summary

Constructors

Constructor and Description
Form(Content content) Create a form with the given Content.
Form(Content content, Document document) Create a form with the given Content.

Method Summary

Modifier and Type	Method and Description
Form	clone() Creates a new form from an existing form object.
Form	colorConvert(Document document, ColorProfile prof, RenderIntent intent, boolean embed) Applies the specified ICC ColorProfile to the objects in the form
void	delete()
Content	getContent() The Content contained in the form.
GraphicState	getGraphicState() Get the graphic state of this Form.
OptionalContentMembershipDict	getOptionalContentMembershipDict() The OptionalContentMembershipDict property for this Form.
PDFStream	getStream() Get the stream associated with the form.
boolean	isCurrentlyVisible(OptionalContentContext occ) 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.
boolean	isCurrentlyVisible(OptionalContentContext occ, Content content) Tests whether an form is visible in a given optional content context and content.
boolean	makeVisible(OptionalContentContext occ, Content content) Makes a form visible in a given optional content context and content by manipulating the ON-OFF states of the optional content groups.
void	setContent(Content content) The Content contained in the form.
void	setGraphicState(GraphicState gstate) Set the Graphic State of this Form.
void	setOptionalContentMembershipDict(OptionalContentMembershipDict ocmd) The OptionalContentMembershipDict property for this Form.

Methods inherited from class com.datalogics.PDFL.Element

clone, getBoundingBox, getClip, getMatrix, rotate, scale, setClip, setMatrix, translate

Methods inherited from class java.lang.Object

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

Constructor Detail

Form

public Form(Content content)

Create a form with the given Content.

Form

public Form(Content content,
            Document document)

Create a form with the given Content.

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

Parameters:

content - The content from which to create the form

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

Method Detail

delete

public void delete()

Overrides:

delete in class Element

getContent

public Content getContent()

The Content contained in the form.

setContent

public void setContent(Content content)

The Content contained in the form.

getStream

public PDFStream getStream()

Get the stream associated with the form.

Returns:

The stream associated with the form.

getGraphicState

public GraphicState getGraphicState()

Get the graphic state of this Form.

May return null if this element does not have a GraphicState.

setGraphicState

public void setGraphicState(GraphicState gstate)

Set the Graphic State of this Form.

Parameters:

gstate - the new/updated Graphic State for the Form.

clone

public Form clone()

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

Overrides:

clone in class Element

Returns:

The newly created form object.

getOptionalContentMembershipDict

public OptionalContentMembershipDict getOptionalContentMembershipDict()

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.

Returns:

the OptionalContentMembershipDict

setOptionalContentMembershipDict

public void setOptionalContentMembershipDict(OptionalContentMembershipDict ocmd)

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.

Parameters:

ocmd - the OptionalContentMembershipDict

isCurrentlyVisible

public boolean isCurrentlyVisible(OptionalContentContext occ)

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.

Returns:

true if the form is currently visible.

isCurrentlyVisible

public boolean isCurrentlyVisible(OptionalContentContext occ,
                                  Content content)

Tests whether an 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.

Returns:

true if the form is currently visible.

makeVisible

public boolean makeVisible(OptionalContentContext occ,
                           Content content)

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

Parameters:

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

content - The content containing the form.

Returns:

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

colorConvert

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

Applies the specified ICC ColorProfile to the objects in the form

Parameters:

document - The document the element belongs to.

prof - The ICC ColorProfile to be applied.

intent - The ICC Rendering Intent for the ColorProfile

embed - 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:

A new Form with the applied ICC ColorProfile.