com.cete.dynamicpdf.forms
Class Form

java.lang.Object
  |
  +--com.cete.dynamicpdf.Resource
        |
        +--com.cete.dynamicpdf.forms.Form

Direct Known Subclasses:

MergeForm

public abstract class Form

extends Resource

Class provides the base class, representing an PDF form.

Constructor Summary

protected

Form() Creates a new instance of Form class.

Method Summary

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.
FormCalculationOrder	getCalculationOrder() Gets the form's calculation order.
FormFieldAlign	getDefaultAlign() Gets the default alignment for the form.
FormFieldList	getFields() Gets a collection of fields for the form.
int	getRequiredLicenseLevel() Gets a value indicating the required license level for the form.
int	getRequiredPdfObjects() Gets the number of PDF objects required by the form.
SignatureFlags	getSignatureFlags() Gets the signature flags for the form.
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	requireLicense(int requiredLicenseLevel) Sets the required license level for the form.
void	setDefaultAlign(FormFieldAlign value) Sets the default alignment for the form.
void	setNeedsAppearances(boolean value) Sets a value indicating if the form needs appearance streams.
void	setReadOnly(boolean value) Sets a value indicating if the form is read only.
void	setSignatureFlags(SignatureFlags value) Sets the signature flags for the form.

Methods inherited from class com.cete.dynamicpdf.Resource

getUid, newUid

Methods inherited from class java.lang.Object

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

Constructor Detail

Form

protected Form()

Creates a new instance of Form class.

See Also:

Form

Method Detail

getRequiredPdfObjects

public int getRequiredPdfObjects()

Gets the number of PDF objects required by the form.

Specified by:

getRequiredPdfObjects in class Resource

Returns:

A value specifing the number of PDF objects required by the form.

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.

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.

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