com.cete.dynamicpdf.forms
Class Form

java.lang.Object
  com.cete.dynamicpdf.Resource
      com.cete.dynamicpdf.forms.Form

public class Form
extends Resource

Class provides the base class, representing an PDF form.

Licensing:
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Standard Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

Method Summary

void	addFormFieldsAddedEventListener(FormFieldsAddedEventListener formFieldsAddedEventListener) Adds the formFieldsAddedEventListener for the form event.
void	draw(DocumentWriter writer) Draws the form to the given DocumentWriter object.
protected void	drawDictionary(DocumentWriter writer) Draws the form's dictionary entries to the given DocumentWriter object.
Align	getAlign() Gets the document�s wide alignment for variable text fields.
FormCalculationOrder	getCalculationOrder() Gets the form's calculation order.
FormFieldAlign	getDefaultAlign() Gets the default alignment for the form.
java.lang.String	getDefaultAppearance() Gets the default appearance for the form.
DeviceColor	getDefaultColor() Gets the defualt color for all the variable text fields.
Font	getDefaultFont() Gets the font default for all the variable text fields.
float	getDefaultFontSize() Gets the default font size for all the variable text fields.
Resource	getDefaultResources() Gets the default resource for the form.
boolean	getExcludeXfaDataIfValuesChanged() Gets a value indicating to exclude the XFA if the form field value is changed.
FormFieldList	getFields() Gets a collection of fields for the form.
FormOutput	getOutput() Gets the output options for the form.
int	getRequiredLicenseLevel() Gets a value indicating the required license level for the form.
FormFieldOutput	getSignatureFieldsOutput() Gets output options for the signature fields.
SignatureFlags	getSignatureFlags() Gets the signature flags for the form.
Font	getSubstituteFont() Gets the Font to be used as a substitute font for form fields.
TextFieldList	getTextFields() Returns a collection of text form fields.
boolean	isReadOnly() Gets a value indicating if the form is read only.
boolean	needsAppearances() Gets a value indicating if the form needs appearance streams.
void	removeFormFieldsAddedEventListener(FormFieldsAddedEventListener formFieldsAddedEventListener) Removes the formFieldsAddedEventListener for the form event.
void	requireLicense(int requiredLicenseLevel) Sets the required license level for the form.
void	setAlign(Align align) Sets the document�s wide alignment for variable text fields.
void	setDefaultAlign(FormFieldAlign value) Sets the default alignment for the form.
void	setDefaultAppearance(java.lang.String value) Sets the default appearance for the form.
void	setDefaultResources(Resource resource) Sets the default resource for the form.
void	setExcludeXfaDataIfValuesChanged(boolean value) Sets a value indicating to exclude the XFA if the form field value is changed.
void	setNeedsAppearances(boolean value) Sets a value indicating if the form needs appearance streams.
void	setOutput(FormOutput value) Sets the output options for the form.
void	setReadOnly(boolean value) Sets a value indicating if the form is read only.
void	setSignatureFieldsOutput(FormFieldOutput value) Sets output options for the signature fields.
void	setSignatureFlags(SignatureFlags value) Sets the signature flags for the form.
void	setSubstituteFont(Font value) Sets the Font to be used as a substitute font for form fields.

Methods inherited from class com.cete.dynamicpdf.Resource

getRequiredPdfObjects, getResourceType, getUid, newUid

Methods inherited from class java.lang.Object

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

Method Detail

getDefaultResources

public Resource getDefaultResources()

Gets the default resource for the form.

Returns:

A Resource object representing the default resource for the form.

See Also:

Resource

setDefaultResources

public void setDefaultResources(Resource resource)

Sets the default resource for the form.

Parameters:

resource - specifing the default resource for the form.

getDefaultAppearance

public java.lang.String getDefaultAppearance()

Gets the default appearance for the form.

Returns:

A string value indicating the default appearance for the form.

setDefaultAppearance

public void setDefaultAppearance(java.lang.String value)

Sets the default appearance for the form.

Parameters:

value - specifing the default appearance for the form.

getDefaultFont

public Font getDefaultFont()

Gets the font default for all the variable text fields.

Returns:

default font for all the variable text fields.

getDefaultFontSize

public float getDefaultFontSize()

Gets the default font size for all the variable text fields.

Returns:

A float value representing the default font size for all the variable text fields.

getDefaultColor

public DeviceColor getDefaultColor()

Gets the defualt color for all the variable text fields.

Returns:

A DeviceColor object representing the defualt color for all the variable text fields.

getAlign

public Align getAlign()

Gets the document�s wide alignment for variable text fields.

Returns:

A Align object representing the document�s wide alignment for variable text fields.

See Also:

Align

setAlign

public void setAlign(Align align)

Sets the document�s wide alignment for variable text fields.

Parameters:

align - specifying the document�s wide alignment for variable text fields.

getFields

public FormFieldList getFields()

Gets a collection of fields for the form.

Returns:

A FormFieldList object representing a collection of fields for the form.

isReadOnly

public boolean isReadOnly()

Gets a value indicating if the form is read only.

Returns:

A boolean value indicating if the form is read only.

setReadOnly

public void setReadOnly(boolean value)

Sets a value indicating if the form is read only.

Parameters:

value - A boolean value specifing if the form is read only.

getCalculationOrder

public FormCalculationOrder getCalculationOrder()

Gets the form's calculation order.

Returns:

the form's calculation order.

getDefaultAlign

public FormFieldAlign getDefaultAlign()

Gets the default alignment for the form.

Returns:

the default alignment for the form.

setDefaultAlign

public void setDefaultAlign(FormFieldAlign value)

Sets the default alignment for the form.

Parameters:

value - specifing the default alignment for the form.

getSignatureFlags

public SignatureFlags getSignatureFlags()

Gets the signature flags for the form.

Returns:

the signature flags for the form.

setSignatureFlags

public void setSignatureFlags(SignatureFlags value)

Sets the signature flags for the form.

Parameters:

value - the signature flags for the form.

needsAppearances

public boolean needsAppearances()

Gets a value indicating if the form needs appearance streams.

Returns:

A boolean value indicating if the form needs appearance streams.

setNeedsAppearances

public void setNeedsAppearances(boolean value)

Sets a value indicating if the form needs appearance streams.

Parameters:

value - indicating if the form needs appearance streams.

getExcludeXfaDataIfValuesChanged

public boolean getExcludeXfaDataIfValuesChanged()

Gets a value indicating to exclude the XFA if the form field value is changed.

setExcludeXfaDataIfValuesChanged

public void setExcludeXfaDataIfValuesChanged(boolean value)

Sets a value indicating to exclude the XFA if the form field value is changed.

getRequiredLicenseLevel

public int getRequiredLicenseLevel()

Gets a value indicating the required license level for the form.

Returns:

A value indicating the required license level for the form.

draw

public void draw(DocumentWriter writer)

Draws the form to the given DocumentWriter object.

Specified by:

draw in class Resource

Parameters:

writer - DocumentWriter object to receive the form's output.

See Also:

DocumentWriter

getTextFields

public TextFieldList getTextFields()

Returns a collection of text form fields.

Returns:

A TextFieldList object containing the visible form fields.

See Also:

TextFieldList

requireLicense

public void requireLicense(int requiredLicenseLevel)

Sets the required license level for the form.

Parameters:

requiredLicenseLevel - The license level required.

addFormFieldsAddedEventListener

public void addFormFieldsAddedEventListener(FormFieldsAddedEventListener formFieldsAddedEventListener)

Adds the formFieldsAddedEventListener for the form event.

Parameters:

formFieldsAddedEventListener - specifing the formFieldsAddedEventListener for the form event.

See Also:

FormFieldsAddedEventListener

removeFormFieldsAddedEventListener

public void removeFormFieldsAddedEventListener(FormFieldsAddedEventListener formFieldsAddedEventListener)

Removes the formFieldsAddedEventListener for the form event.

Parameters:

formFieldsAddedEventListener - specifing the formFieldsAddedEventListener for the form event.

See Also:

FormFieldsAddedEventListener

drawDictionary

protected void drawDictionary(DocumentWriter writer)

Draws the form's dictionary entries to the given DocumentWriter object.

Parameters:

writer - DocumentWriter object to receive the output.

See Also:

DocumentWriter

getSubstituteFont

public Font getSubstituteFont()

Gets the Font to be used as a substitute font for form fields.

setSubstituteFont

public void setSubstituteFont(Font value)

Sets the Font to be used as a substitute font for form fields.

getOutput

public FormOutput getOutput()

Gets the output options for the form.

Returns:

the output options for the form.

setOutput

public void setOutput(FormOutput value)

Sets the output options for the form.

Parameters:

value - the output options for the form.

getSignatureFieldsOutput

public FormFieldOutput getSignatureFieldsOutput()

Gets output options for the signature fields.

Returns:

The output options for the signature fields.

setSignatureFieldsOutput

public void setSignatureFieldsOutput(FormFieldOutput value)

Sets output options for the signature fields.

Parameters:

value - The output options for the signature fields.