com.foxit.sdk.pdf.annots.MarkupArray Class Reference

Public Member Functions

 MarkupArray ()
 Constructor.

 
 MarkupArray (MarkupArray arg0)
 Constructor, with another array object.

 
void add (Markup element)
 Add an element to the end of current array.
More...
 
Markup getAt (long index)
 Retrieve a copy of the element at position specified by index in current array.
More...
 
long getSize ()
 Get the size of current array.
More...
 
void insertAt (long index, Markup 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 Markup objects.

Member Function Documentation

◆ add()

void com.foxit.sdk.pdf.annots.MarkupArray.add ( Markup  element)

Add an element to the end of current array.

Parameters
elementNew element to be added to current array.
Returns
None.

◆ getAt()

Markup com.foxit.sdk.pdf.annots.MarkupArray.getAt ( long  index)

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

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

◆ getSize()

long com.foxit.sdk.pdf.annots.MarkupArray.getSize ( )

Get the size of current array.

Returns
The size.

◆ insertAt()

void com.foxit.sdk.pdf.annots.MarkupArray.insertAt ( long  index,
Markup  element 
)

Insert an element before the position specified by index.

Parameters
indexAn index to specify where to insert the new element. Valid range: from 0 to (count-1). count is returned by function GetSize() .
elementNew element to be inserted to current array.
Returns
None.

◆ removeAll()

void com.foxit.sdk.pdf.annots.MarkupArray.removeAll ( )

Remove all the element from current array.

Returns
None.

◆ removeAt()

void com.foxit.sdk.pdf.annots.MarkupArray.removeAt ( long  index)

Remove the element in position specified by index.

Parameters
indexAn index to specify which element is to be removed. Valid range: from 0 to (count-1). count is returned by function GetSize() .
Returns
None.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.