com.lowagie.text.pdf

Class AcroFields.Item

public static class AcroFields.Item extends Object

The field representations for retrieval and modification.
Field Summary
ArrayListmerged
An array of PdfDictionary with all the field and widget tags merged.
ArrayListpage
An array of Integer with the page numbers where the widgets are displayed.
ArrayListtabOrder
An array of Integer with the tab order of the field in the page.
ArrayListvalues
An array of PdfDictionary where the value tag /V is present.
ArrayListwidgets
An array of PdfDictionary with the widgets.
ArrayListwidget_refs
An array of PdfDictionary with the widget references.
static intWRITE_MERGED
writeToAll constant.
static intWRITE_VALUE
writeToAll and markUsed constant.
static intWRITE_WIDGET
writeToAll and markUsed constant.
Method Summary
voidaddMerged(PdfDictionary mergeDict)
Adds a merged dictionary to this Item.
voidaddPage(int pg)
Adds a page to the current Item.
voidaddTabOrder(int order)
Adds a tab order value to this Item.
voidaddValue(PdfDictionary value)
Add a value dict to this Item
voidaddWidget(PdfDictionary widget)
Add a widget dict to this Item
voidaddWidgetRef(PdfIndirectReference widgRef)
Add a widget ref to this Item
voidforcePage(int idx, int pg)
forces a page value into the Item.
PdfDictionarygetMerged(int idx)
Retrieve the merged dictionary for the given instance.
IntegergetPage(int idx)
Retrieve the page number of the given instance
IntegergetTabOrder(int idx)
Gets the tabOrder.
PdfDictionarygetValue(int idx)
Retrieve the value dictionary of the given instance
PdfDictionarygetWidget(int idx)
Retrieve the widget dictionary of the given instance
PdfIndirectReferencegetWidgetRef(int idx)
Retrieve the reference to the given instance
voidmarkUsed(AcroFields parentFields, int writeFlags)
Mark all the item dictionaries used matching the given flags
voidremove(int killIdx)
Remove the given instance from this item.
intsize()
Preferred method of determining the number of instances of a given field.
voidwriteToAll(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

Field Detail

merged

public ArrayList merged

Deprecated: (will remove 'public' in the future)

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

page

public ArrayList page

Deprecated: (will remove 'public' in the future)

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

tabOrder

public ArrayList tabOrder

Deprecated: (will remove 'public' in the future)

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

values

public ArrayList values

Deprecated: (will remove 'public' in the future)

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

widgets

public ArrayList widgets

Deprecated: (will remove 'public' in the future)

An array of PdfDictionary with the widgets.

widget_refs

public ArrayList widget_refs

Deprecated: (will remove 'public' in the future)

An array of PdfDictionary with the widget references.

WRITE_MERGED

public static final int WRITE_MERGED
writeToAll constant.

Since: 2.1.5

WRITE_VALUE

public static final int WRITE_VALUE
writeToAll and markUsed constant.

Since: 2.1.5

WRITE_WIDGET

public static final int WRITE_WIDGET
writeToAll and markUsed constant.

Since: 2.1.5

Method Detail

addMerged

void addMerged(PdfDictionary mergeDict)
Adds a merged dictionary to this Item.

Parameters: mergeDict

Since: 2.1.5

addPage

void addPage(int pg)
Adds a page to the current Item.

Parameters: pg

Since: 2.1.5

addTabOrder

void addTabOrder(int order)
Adds a tab order value to this Item.

Parameters: order

Since: 2.1.5

addValue

void addValue(PdfDictionary value)
Add a value dict to this Item

Parameters: value new value dictionary

Since: 2.1.5

addWidget

void addWidget(PdfDictionary widget)
Add a widget dict to this Item

Parameters: widget

Since: 2.1.5

addWidgetRef

void addWidgetRef(PdfIndirectReference widgRef)
Add a widget ref to this Item

Parameters: widgRef

Since: 2.1.5

forcePage

void forcePage(int idx, int pg)
forces a page value into the Item.

Parameters: idx

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

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

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

remove

void remove(int killIdx)
Remove the given instance from this item. It is possible to remove all instances using this function.

Parameters: killIdx

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

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