com.cete.dynamicpdf.pageelements.forms
Class ChoiceItemList

java.lang.Object
  com.cete.dynamicpdf.pageelements.forms.ChoiceItemList

public class ChoiceItemList
extends java.lang.Object

Represents the ChoiceItemList which holds the item of choice field of interactive forms.

Licensing:
This class is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Enterprise Edition

Constructor Summary

ChoiceItemList()

Method Summary

ChoiceItem	add(java.lang.String itemName) Adds the item to the list.
ChoiceItem	add(java.lang.String itemName, boolean selected) Adds the item to the list.
ChoiceItem	add(java.lang.String itemName, java.lang.String exportValue) Adds the item to the list.
ChoiceItem	add(java.lang.String itemName, java.lang.String exportValue, boolean selected) Adds the item to the list.
ChoiceItem	getChoiceItem(int index) Gets the ChoiceItem from the list with a given index.
ChoiceItem	getChoiceItem(java.lang.String itemName) Gets the ChoiceItem from the list with the given item name.
void	remove(int index) Removes the item from the list.
int	size() Gets the number of items available in the item list.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChoiceItemList

public ChoiceItemList()

Method Detail

add

public ChoiceItem add(java.lang.String itemName)

Adds the item to the list. No duplicate items are allowed.

Parameters:

itemName - ItemName to be added to the list.

Returns:

the choice item.

add

public ChoiceItem add(java.lang.String itemName,
                      java.lang.String exportValue)

Adds the item to the list. No duplicate items are allowed.

Parameters:

itemName - ItemName to be added to the list.

exportValue - ExportValue for the item.

Returns:

the choice item.

add

public ChoiceItem add(java.lang.String itemName,
                      boolean selected)

Adds the item to the list. No duplicate items are allowed.

Parameters:

itemName - ItemName to be added to the list.

selected - The item to be selected.

Returns:

the choice item.

add

public ChoiceItem add(java.lang.String itemName,
                      java.lang.String exportValue,
                      boolean selected)

Adds the item to the list. No duplicate items are allowed.

Parameters:

itemName - ItemName to be added to the list.

exportValue - ExportValue for the item.

selected - The item to be selected.

Returns:

the choice item.

size

public int size()

Gets the number of items available in the item list.

Returns:

size of the list.

getChoiceItem

public ChoiceItem getChoiceItem(int index)

Gets the ChoiceItem from the list with a given index.

Parameters:

index - Item index in the list.

Returns:

the choice item.

getChoiceItem

public ChoiceItem getChoiceItem(java.lang.String itemName)

Gets the ChoiceItem from the list with the given item name.

Parameters:

itemName - Item name in the list.

Returns:

choice item realted to he given item name.

remove

public void remove(int index)

Removes the item from the list.

Parameters:

index - Item index to be removed from the list.