PdfArray
Overview
PdfArray is a class in Aspose.PDF FOSS for Java.
Inherits from: PdfBase, Iterable<PdfBase>.
PDF array object (§7.3.6, ISO 32000-1:2008).
This class provides 30 methods for working with PdfArray objects in Java programs.
Available methods include: PdfArray, accept, add, clear, equals, get, getArray, getDictionary, getFloat, getInt, getLong, getName, and 16 additional methods.
All public members are accessible to any Java application after installing the Aspose.PDF FOSS for Java package.
Properties: dirty, empty, indirect, objectKey.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
empty | boolean | Read | Returns whether the array is empty. |
dirty | boolean | Read | Returns {@code true} if this object was modified since loading. |
indirect | boolean | Read | Returns whether this object is an indirect object (has an object key). |
objectKey | PdfObjectKey | Read | Returns the indirect object key, or {@code null} for direct objects. |
Methods
| Signature | Description |
|---|---|
PdfArray() | Creates an empty array with default initial capacity. |
PdfArray(initialCapacity: int) | Creates an empty array with the specified initial capacity. |
size() → int | Returns the number of elements. |
isEmpty() → boolean | Returns whether the array is empty. |
get(index: int) → PdfBase | Returns the element at the given index. |
add(item: PdfBase) | Appends an element to the end. |
add(index: int, item: PdfBase) | Inserts an element at the given index. |
set(index: int, item: PdfBase) → PdfBase | Replaces the element at the given index. |
remove(index: int) → PdfBase | Removes the element at the given index. |
clear() | Removes all elements. |
getInt(index: int, defaultValue: int) → int | Returns the element at the given index as an int, or the default value |
| if the element is not a numeric type. | |
getLong(index: int, defaultValue: long) → long | Returns the element at the given index as a long, or the default value. |
getFloat(index: int, defaultValue: float) → float | Returns the element at the given index as a float, or the default value. |
getName(index: int) → String | Returns the element at the given index as a name string, or null. |
getString(index: int) → String | Returns the element at the given index as a string value, or null. |
getDictionary(index: int) → PdfDictionary | Returns the element at the given index as a PdfDictionary, or null. |
getArray(index: int) → PdfArray | Returns the element at the given index as a PdfArray, or null. |
toFloatArray() → float[] | Converts this array to a float[]. |
toIntArray() → int[] | Converts this array to an int[]. |
iterator() → Iterator<PdfBase> | |
writeTo(os: OutputStream) | |
accept(visitor: IPdfVisitor<T>) → T | |
equals(o: Object) → boolean | |
hashCode() → int | |
toString() → String | |
isDirty() → boolean | Returns {@code true} if this object was modified since loading. |
setDirty(dirty: boolean) | Sets the dirty flag on this object. |
isIndirect() → boolean | Returns whether this object is an indirect object (has an object key). |
getObjectKey() → PdfObjectKey | Returns the indirect object key, or {@code null} for direct objects. |
setObjectKey(key: PdfObjectKey) | Sets the indirect object key. |