|
| GraphicsObjectArray () |
| Construct a simple object.
|
|
| GraphicsObjectArray (GraphicsObjectArray other) |
| Constructor, with another array object. More...
|
|
boolean | add (GraphicsObject newElement) |
| Add an element at the tail. Potentially growing the array. More...
|
|
synchronized void | delete () |
| Clean up related resources immediately. More...
|
|
int | find (GraphicsObject data, int iStart) |
| Find an element from specified position to last. More...
|
|
GraphicsObject | getAt (int nIndex) |
| This method retrieves an element specified by an index number. More...
|
|
int | getSize () |
| Get the number of elements in the array. More...
|
|
int | getUpperBound () |
| Get the upper bound in the array, actually the maximum valid index. More...
|
|
boolean | insertAt (int nIndex, GraphicsObject newElement, int nCount) |
| Inset one or more continuous element at specified position. More...
|
|
boolean | insertAt (int nStartIndex, BasicArray pNewArray) |
| Inset an array at specified position. More...
|
|
void | removeAll () |
| Clean up the array. More...
|
|
boolean | removeAt (int nIndex, int nCount) |
| Remove a number of elements at specified position. More...
|
|
boolean | setAt (int nIndex, GraphicsObject newElement) |
| This method overwrites an element specified by an index number. More...
|
|
boolean | setAtGrow (int nIndex, GraphicsObject newElement) |
| Set an element value at specified position. Potentially growing the array. More...
|
|
boolean | setSize (int nNewSize, int nGrowBy) |
| Change the allocated size and the grow amount. More...
|
|
This class represents an array of com.foxit.sdk.pdf.graphics.GraphicsObject objects.
◆ GraphicsObjectArray()
com.foxit.sdk.pdf.graphics.GraphicsObjectArray.GraphicsObjectArray |
( |
GraphicsObjectArray |
other | ) |
|
Constructor, with another array object.
- Parameters
-
[in] | other | Another array object. |
◆ add()
boolean com.foxit.sdk.pdf.graphics.GraphicsObjectArray.add |
( |
GraphicsObject |
newElement | ) |
|
Add an element at the tail. Potentially growing the array.
- Parameters
-
[in] | newElement | The input element. |
- Returns
- true means success, while false means failure (such as memory error).
◆ delete()
synchronized void com.foxit.sdk.pdf.graphics.GraphicsObjectArray.delete |
( |
| ) |
|
Clean up related resources immediately.
- Returns
- None.
- Note
- Once this function is called, current object cannot be used anymore.
◆ find()
int com.foxit.sdk.pdf.graphics.GraphicsObjectArray.find |
( |
GraphicsObject |
data, |
|
|
int |
iStart |
|
) |
| |
Find an element from specified position to last.
- Parameters
-
[in] | data | The input element. |
[in] | iStart | Specifies the zero-based index of start element to find. |
- Returns
- An index of the found element. -1 means found none.
◆ getAt()
GraphicsObject com.foxit.sdk.pdf.graphics.GraphicsObjectArray.getAt |
( |
int |
nIndex | ) |
|
This method retrieves an element specified by an index number.
- Parameters
-
[in] | nIndex | Specifies the zero-based index of the element. |
- Returns
- An element.
◆ getSize()
int com.foxit.sdk.pdf.graphics.GraphicsObjectArray.getSize |
( |
| ) |
|
Get the number of elements in the array.
- Returns
- The number of elements in the array.
◆ getUpperBound()
int com.foxit.sdk.pdf.graphics.GraphicsObjectArray.getUpperBound |
( |
| ) |
|
Get the upper bound in the array, actually the maximum valid index.
- Returns
- The upper bound.
◆ insertAt() [1/2]
bool com.foxit.sdk.common.fxcrt.GraphicsObjectArray.insertAt |
( |
int |
nIndex, |
|
|
GraphicsObject |
newElement, |
|
|
int |
nCount |
|
) |
| |
Inset one or more continuous element at specified position.
- Parameters
-
[in] | nIndex | Specifies the zero-based index in the array. |
[in] | newElement | Specifies the element value to insert. |
[in] | nCount | Specifies the count of the element to insert. |
- Returns
- true means success, while false means failure (such as parameter or memory error).
◆ insertAt() [2/2]
bool com.foxit.sdk.common.fxcrt.GraphicsObjectArray.insertAt |
( |
int |
nStartIndex, |
|
|
BasicArray |
pNewArray |
|
) |
| |
Inset an array at specified position.
- Parameters
-
[in] | nStartIndex | Specifies the zero-based index of start element to insert at. |
[in] | pNewArray | The input array. |
- Returns
- true means success, while false means failure (such as parameter or memory error).
◆ removeAll()
void com.foxit.sdk.pdf.graphics.GraphicsObjectArray.removeAll |
( |
| ) |
|
Clean up the array.
- Returns
- None.
◆ removeAt()
boolean com.foxit.sdk.pdf.graphics.GraphicsObjectArray.removeAt |
( |
int |
nIndex, |
|
|
int |
nCount |
|
) |
| |
Remove a number of elements at specified position.
- Parameters
-
[in] | nIndex | Specifies the zero-based index in the array. |
[in] | nCount | Specifies the count of element to remove. |
- Returns
- true means success, while false means failure (such as parameter or memory error).
◆ setAt()
boolean com.foxit.sdk.pdf.graphics.GraphicsObjectArray.setAt |
( |
int |
nIndex, |
|
|
GraphicsObject |
newElement |
|
) |
| |
This method overwrites an element specified by an index number.
- Parameters
-
[in] | nIndex | Specifies the zero-based index of the element. |
[in] | newElement | An element. |
- Returns
- true means success, while false means failure.
◆ setAtGrow()
boolean com.foxit.sdk.pdf.graphics.GraphicsObjectArray.setAtGrow |
( |
int |
nIndex, |
|
|
GraphicsObject |
newElement |
|
) |
| |
Set an element value at specified position. Potentially growing the array.
- Parameters
-
[in] | nIndex | Specifies the zero-based index of element in the array. |
[in] | newElement | The input element. |
- Returns
- true means success, while false means failure.
◆ setSize()
boolean com.foxit.sdk.pdf.graphics.GraphicsObjectArray.setSize |
( |
int |
nNewSize, |
|
|
int |
nGrowBy |
|
) |
| |
Change the allocated size and the grow amount.
- Parameters
-
[in] | nNewSize | The new size in elements expected. |
[in] | nGrowBy | The grow amount in elements expected. This can be -1 for the grow amount unchanged. |
- Returns
- true means success, while false means failure (such as parameter or memory error).