Foxit PDF SDK
com.foxit.sdk.pdf.interform.ChoiceOptionArray Class Reference

Public Member Functions

 ChoiceOptionArray ()
 Constructor.
 
 ChoiceOptionArray (ChoiceOptionArray other)
 Constructor, with another array object. More...
 
void add (ChoiceOption element)
 Add an element to the end of current array. More...
 
synchronized void delete ()
 Clean up related resources immediately. More...
 
ChoiceOption getAt (long index)
 Retrieve a copy of the element at position specified by index in current array. More...
 
long getSize ()
 Get the size of elements in current array. More...
 
void insertAt (long index, ChoiceOption element)
 Insert an element before the position specified by index. More...
 
void removeAll ()
 Remove all the element from current array. More...
 
void removeAt (long index)
 Remove the element in position specified by index. More...
 

Detailed Description

This class represents an array of choice options.

Constructor & Destructor Documentation

◆ ChoiceOptionArray()

com.foxit.sdk.pdf.interform.ChoiceOptionArray.ChoiceOptionArray ( ChoiceOptionArray  other)

Constructor, with another array object.

Parameters
[in]otherAnother array object.

Member Function Documentation

◆ add()

void com.foxit.sdk.pdf.interform.ChoiceOptionArray.add ( ChoiceOption  element)

Add an element to the end of current array.

Parameters
[in]elementNew element to be added to current array.
Returns
None.

◆ delete()

synchronized void com.foxit.sdk.pdf.interform.ChoiceOptionArray.delete ( )

Clean up related resources immediately.

Returns
None.
Note
Once this function is called, current object cannot be used anymore.

◆ getAt()

ChoiceOption com.foxit.sdk.pdf.interform.ChoiceOptionArray.getAt ( long  index)

Retrieve a copy of the element at position specified by index in current array.

Parameters
[in]indexAn index to specify which element is to be retrieved.
Returns
A copy of an element.

◆ getSize()

long com.foxit.sdk.pdf.interform.ChoiceOptionArray.getSize ( )

Get the size of elements in current array.

Returns
The size.

◆ insertAt()

void com.foxit.sdk.pdf.interform.ChoiceOptionArray.insertAt ( long  index,
ChoiceOption  element 
)

Insert an element before the position specified by index.

Parameters
[in]indexAn index to specify where to insert the new element. Valid range: from 0 to (size-1). size is the size of elements in current array.
[in]elementNew element to be inserted to current array.
Returns
None.

◆ removeAll()

void com.foxit.sdk.pdf.interform.ChoiceOptionArray.removeAll ( )

Remove all the element from current array.

Returns
None.

◆ removeAt()

void com.foxit.sdk.pdf.interform.ChoiceOptionArray.removeAt ( long  index)

Remove the element in position specified by index.

Parameters
[in]indexAn index to specify which element is to be removed. Valid range: from 0 to (size-1). size is the size of elements in current array.
Returns
None.