com.itextpdf.text.pdf
Class AcroFields.Item

java.lang.Object
  com.itextpdf.text.pdf.AcroFields.Item

Enclosing class:

AcroFields

public static class AcroFields.Item
extends Object

The field representations for retrieval and modification.

Field Summary

protected ArrayList<PdfDictionary>	merged An array of PdfDictionary with all the field and widget tags merged.
protected ArrayList<Integer>	page An array of Integer with the page numbers where the widgets are displayed.
protected ArrayList<Integer>	tabOrder An array of Integer with the tab order of the field in the page.
protected ArrayList<PdfDictionary>	values An array of PdfDictionary where the value tag /V is present.
protected ArrayList<PdfIndirectReference>	widget_refs An array of PdfDictionary with the widget references.
protected ArrayList<PdfDictionary>	widgets An array of PdfDictionary with the widgets.
static int	WRITE_MERGED writeToAll constant.
static int	WRITE_VALUE writeToAll and markUsed constant.
static int	WRITE_WIDGET writeToAll and markUsed constant.

Constructor Summary

AcroFields.Item()

Method Summary

PdfDictionary	getMerged(int idx) Retrieve the merged dictionary for the given instance.
Integer	getPage(int idx) Retrieve the page number of the given instance
Integer	getTabOrder(int idx) Gets the tabOrder.
PdfDictionary	getValue(int idx) Retrieve the value dictionary of the given instance
PdfDictionary	getWidget(int idx) Retrieve the widget dictionary of the given instance
PdfIndirectReference	getWidgetRef(int idx) Retrieve the reference to the given instance
void	markUsed(AcroFields parentFields, int writeFlags) Mark all the item dictionaries used matching the given flags
int	size() Preferred method of determining the number of instances of a given field.
void	writeToAll(PdfName key, PdfObject value, int writeFlags) This function writes the given key/value pair to all the instances of merged, widget, and/or value, depending on the writeFlags setting

Methods inherited from class java.lang.Object

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

Field Detail

WRITE_MERGED

public static final int WRITE_MERGED

writeToAll constant.

Since:

2.1.5

See Also:

Constant Field Values

WRITE_WIDGET

public static final int WRITE_WIDGET

writeToAll and markUsed constant.

Since:

2.1.5

See Also:

Constant Field Values

WRITE_VALUE

public static final int WRITE_VALUE

writeToAll and markUsed constant.

Since:

2.1.5

See Also:

Constant Field Values

values

protected ArrayList<PdfDictionary> values

An array of PdfDictionary where the value tag /V is present.

Since:

5.0.2 public is now protected

widgets

protected ArrayList<PdfDictionary> widgets

An array of PdfDictionary with the widgets.

Since:

5.0.2 public is now protected

widget_refs

protected ArrayList<PdfIndirectReference> widget_refs

An array of PdfDictionary with the widget references.

Since:

5.0.2 public is now protected

merged

protected ArrayList<PdfDictionary> merged

An array of PdfDictionary with all the field and widget tags merged.

Since:

5.0.2 public is now protected

page

protected ArrayList<Integer> page

An array of Integer with the page numbers where the widgets are displayed.

Since:

5.0.2 public is now protected

tabOrder

protected ArrayList<Integer> tabOrder

An array of Integer with the tab order of the field in the page.

Since:

5.0.2 public is now protected

Constructor Detail

AcroFields.Item

public AcroFields.Item()

Method Detail

writeToAll

public void writeToAll(PdfName key,
                       PdfObject value,
                       int writeFlags)

This function writes the given key/value pair to all the instances of merged, widget, and/or value, depending on the writeFlags setting

Parameters:

key - you'll never guess what this is for.

value - if value is null, the key will be removed

writeFlags - ORed together WRITE_* flags

Since:

2.1.5

markUsed

public void markUsed(AcroFields parentFields,
                     int writeFlags)

Mark all the item dictionaries used matching the given flags

Parameters:

writeFlags - WRITE_MERGED is ignored

Since:

2.1.5

size

public int size()

Preferred method of determining the number of instances of a given field.

Returns:

number of instances

Since:

2.1.5

getValue

public PdfDictionary getValue(int idx)

Retrieve the value dictionary of the given instance

Parameters:

idx - instance index

Returns:

dictionary storing this instance's value. It may be shared across instances.

Since:

2.1.5

getWidget

public PdfDictionary getWidget(int idx)

Retrieve the widget dictionary of the given instance

Parameters:

idx - instance index

Returns:

The dictionary found in the appropriate page's Annot array.

Since:

2.1.5

getWidgetRef

public PdfIndirectReference getWidgetRef(int idx)

Retrieve the reference to the given instance

Parameters:

idx - instance index

Returns:

reference to the given field instance

Since:

2.1.5

getMerged

public PdfDictionary getMerged(int idx)

Retrieve the merged dictionary for the given instance. The merged dictionary contains all the keys present in parent fields, though they may have been overwritten (or modified?) by children. Example: a merged radio field dict will contain /V

Parameters:

idx - instance index

Returns:

the merged dictionary for the given instance

Since:

2.1.5

getPage

public Integer getPage(int idx)

Retrieve the page number of the given instance

Parameters:

idx -

Returns:

remember, pages are "1-indexed", not "0-indexed" like field instances.

Since:

2.1.5

getTabOrder

public Integer getTabOrder(int idx)

Gets the tabOrder.

Parameters:

idx -

Returns:

tab index of the given field instance

Since:

2.1.5