com.foxit.sdk.pdf.interform.FieldArray Class Reference

Public Member Functions

 FieldArray ()
 Constructor.

 
 FieldArray (FieldArray other)
 Constructor, with another array object.
More...
 
void add (Field element)
 Add an element to the end of current array.
More...
 
Field 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, Field 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 form fields.

Constructor & Destructor Documentation

◆ FieldArray()

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

Constructor, with another array object.

Parameters
[in]otherAnother array object.

Member Function Documentation

◆ add()

void com.foxit.sdk.pdf.interform.FieldArray.add ( Field  element)

Add an element to the end of current array.

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

◆ getAt()

Field com.foxit.sdk.pdf.interform.FieldArray.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.FieldArray.getSize ( )

Get the size of elements in current array.

Returns
The size.

◆ insertAt()

void com.foxit.sdk.pdf.interform.FieldArray.insertAt ( long  index,
Field  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.FieldArray.removeAll ( )

Remove all the element from current array.

Returns
None.

◆ removeAt()

void com.foxit.sdk.pdf.interform.FieldArray.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.