com.aowagie.text.pdf

Class PdfArray

java.lang.Object

com.aowagie.text.pdf.PdfObject

com.aowagie.text.pdf.PdfArray

Direct Known Subclasses:

PdfDestination, PdfRectangle

public class PdfArray
extends PdfObject

PdfArray is the PDF Array object.

An array is a sequence of PDF objects. An array may contain a mixture of object types. An array is written as a left square bracket ([), followed by a sequence of objects, followed by a right square bracket (]).
This object is described in the 'Portable Document Format Reference Manual version 1.7' section 3.2.5 (page 58).

See Also:

PdfObject

Field Summary

Fields inherited from class com.aowagie.text.pdf.PdfObject

ARRAY, bytes, INDIRECT, STREAM, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor and Description
PdfArray() Constructs an empty PdfArray-object.
PdfArray(PdfObject object) Constructs an PdfArray-object, containing 1 PdfObject.

Method Summary

Modifier and Type	Method and Description
boolean	add(float[] values) Adds an array of float values to end of the PdfArray.
boolean	add(int[] values) Adds an array of int values to end of the PdfArray.
boolean	add(PdfObject object) Adds a PdfObject to the end of the PdfArray.
void	addFirst(PdfObject object) Inserts a PdfObject at the beginning of the PdfArray.
ArrayList	getArrayList() Get the internal arrayList for this PdfArray.
PdfName	getAsName(int idx) Returns a PdfObject as a PdfName, resolving indirect references.
PdfNumber	getAsNumber(int idx) Returns a PdfObject as a PdfNumber, resolving indirect references.
PdfObject	getPdfObject(int idx) Returns the PdfObject with the specified index.
boolean	isEmpty() Returns true if the array is empty.
ListIterator<PdfObject>	listIterator() Returns the list iterator for the array.
int	size() Returns the number of entries in the array.
void	toPdf(PdfWriter writer, OutputStream os) Writes the PDF representation of this PdfArray as an array of byte to the specified OutputStream.
String	toString() Returns a string representation of this PdfArray.

Methods inherited from class com.aowagie.text.pdf.PdfObject

getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, setContent, setIndRef, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PdfArray

public PdfArray()

Constructs an empty PdfArray-object.

PdfArray

public PdfArray(PdfObject object)

Constructs an PdfArray-object, containing 1 PdfObject.

Parameters:

object - a PdfObject that has to be added to the array

Method Detail

toPdf

public void toPdf(PdfWriter writer,
                  OutputStream os)
           throws IOException

Writes the PDF representation of this PdfArray as an array of byte to the specified OutputStream.

Overrides:

toPdf in class PdfObject

Parameters:

writer - for backwards compatibility

os - the OutputStream to write the bytes to.

Throws:

IOException - Exception with a I/O error

toString

public String toString()

Returns a string representation of this PdfArray. The string representation consists of a list of all PdfObjects contained in this PdfArray, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space).

Overrides:

toString in class PdfObject

Returns:

the string representation of this PdfArray

getArrayList

public ArrayList getArrayList()

Get the internal arrayList for this PdfArray. Not Recommended.

Returns:

the internal ArrayList. Naughty Naughty.

size

public int size()

Returns the number of entries in the array.

Returns:

the size of the ArrayList

isEmpty

public boolean isEmpty()

Returns true if the array is empty.

Returns:

true if the array is empty

Since:

2.1.5

add

public boolean add(PdfObject object)

Adds a PdfObject to the end of the PdfArray. The PdfObject will be the last element.

Parameters:

object - PdfObject to add

Returns:

always true

add

public boolean add(float[] values)

Adds an array of float values to end of the PdfArray. The values will be the last elements. The float values are internally converted to PdfNumber objects.

Parameters:

values - An array of float values to add

Returns:

always true

add

public boolean add(int[] values)

Adds an array of int values to end of the PdfArray. The values will be the last elements. The int values are internally converted to PdfNumber objects.

Parameters:

values - An array of int values to add

Returns:

always true

addFirst

public void addFirst(PdfObject object)

Inserts a PdfObject at the beginning of the PdfArray. The PdfObject will be the first element, any other elements will be shifted to the right (adds one to their indices).

Parameters:

object - The PdfObject to add

listIterator

public ListIterator<PdfObject> listIterator()

Returns the list iterator for the array.

Returns:

a ListIterator

getPdfObject

public PdfObject getPdfObject(int idx)

Returns the PdfObject with the specified index. A possible indirect references is not resolved, so the returned PdfObject may be either a direct object or an indirect reference, depending on how the object is stored in the PdfArray.

Parameters:

idx - The index of the PdfObject to be returned

Returns:

A PdfObject

getAsNumber

public PdfNumber getAsNumber(int idx)

Returns a PdfObject as a PdfNumber, resolving indirect references. The object corresponding to the specified index is retrieved and resolved to a direct object. If it is a PdfNumber, it is cast down and returned as such. Otherwise null is returned.

Parameters:

idx - The index of the PdfObject to be returned

Returns:

the corresponding PdfNumber object, or null

getAsName

public PdfName getAsName(int idx)

Returns a PdfObject as a PdfName, resolving indirect references. The object corresponding to the specified index is retrieved and resolved to a direct object. If it is a PdfName, it is cast down and returned as such. Otherwise null is returned.

Parameters:

idx - The index of the PdfObject to be returned

Returns:

the corresponding PdfName object, or null