com.cete.dynamicpdf.forms
Class FormFieldList

java.lang.Object
  com.cete.dynamicpdf.forms.FormFieldList

public class FormFieldList
extends java.lang.Object

Class Represents a collection of form fields.

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

int	add(FormField formField) Adds a form field to the collection.
void	drawKidReferences(DocumentWriter writer) Draws the child references to the given DocumentWriter object.
FormField	getFormField(int index) Gets a FormField by index.
FormField	getFormField(java.lang.String name) Gets a FormField by the given name.
java.util.Iterator	getIterator() Returns an Iterator that can iterate through the FormFieldList
FormField	getOwner() Get the FormField that owns the form field list.
TextFieldList	getTextFields() Returns a collection of text form fields.
boolean	remove(FormField field) Removes the field from the collection.
int	size() Gets the number of fields in the list.

Methods inherited from class java.lang.Object

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

Method Detail

size

public int size()

Gets the number of fields in the list.

Returns:

the list size.

getOwner

public FormField getOwner()

Get the FormField that owns the form field list.

Returns:

the FormField that owns the form field list.

See Also:

FormField

getFormField

public FormField getFormField(java.lang.String name)

Gets a FormField by the given name.

Parameters:

name - Name of the field to be retrieved.

Returns:

the form field related to the name.

See Also:

FormField

getFormField

public FormField getFormField(int index)

Gets a FormField by index.

Parameters:

index - index of the form field.

Returns:

form field related to the index.

add

public int add(FormField formField)

Adds a form field to the collection.

Parameters:

formField - FormField object to add.

Returns:

The index of the added form field.

See Also:

FormField

remove

public boolean remove(FormField field)

Removes the field from the collection.

Parameters:

field - the field to remove.

Returns:

true, if it is deleted from the collection. Otherwise, false.

getIterator

public java.util.Iterator getIterator()

Returns an Iterator that can iterate through the FormFieldList

Returns:

An Iterator for the entire FormFieldList

See Also:

Iterator

drawKidReferences

public void drawKidReferences(DocumentWriter writer)

Draws the child references to the given DocumentWriter object.

Parameters:

writer - DocumentWriter object to receive the FormField list's output.

See Also:

DocumentWriter, FormField

getTextFields

public TextFieldList getTextFields()

Returns a collection of text form fields.

Returns:

TextFieldList object containing the visible form fields.