com.lowagie.text.pdf
Class PdfArray

java.lang.Object
  |
  +--com.lowagie.text.pdf.PdfObject
        |
        +--com.lowagie.text.pdf.PdfArray
Direct Known Subclasses:
PdfBorderArray, PdfColor, PdfDashPattern, 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.3' section 4.6 (page 40).

See Also:
PdfObject

Field Summary
protected  ArrayList arrayList
          this is the actual array of PdfObjects
 
Fields inherited from class com.lowagie.text.pdf.PdfObject
ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type
 
Constructor Summary
PdfArray()
          Constructs an empty PdfArray-object.
PdfArray(float[] values)
           
PdfArray(int[] values)
           
PdfArray(PdfArray array)
          Constructs an PdfArray-object, containing all the PdfObjects in a given PdfArray.
PdfArray(PdfObject object)
          Constructs an PdfArray-object, containing 1 PdfObject.
 
Method Summary
 boolean add(float[] values)
           
 boolean add(int[] values)
           
 boolean add(PdfObject object)
          Adds a PdfObject to the PdfArray.
 void addFirst(PdfObject object)
          Adds a PdfObject to the PdfArray.
 boolean contains(PdfObject object)
          Checks if the PdfArray already contains a certain PdfObject.
 ArrayList getArrayList()
          Returns an ArrayList containing PdfObjects.
 int size()
          Returns the number of entries in the array.
 void toPdf(PdfWriter writer, OutputStream os)
          Returns the PDF representation of this PdfArray.
 
Methods inherited from class com.lowagie.text.pdf.PdfObject
getBytes, isArray, isBoolean, isDictionary, isName, isNull, isNumber, isStream, isString, length, setContent, toString, type
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

arrayList

protected ArrayList arrayList
this is the actual array of PdfObjects

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

PdfArray

public PdfArray(float[] values)

PdfArray

public PdfArray(int[] values)

PdfArray

public PdfArray(PdfArray array)
Constructs an PdfArray-object, containing all the PdfObjects in a given PdfArray.

Parameters:
array - a PdfArray that has to be added to the array
Method Detail

toPdf

public void toPdf(PdfWriter writer,
                  OutputStream os)
           throws IOException
Returns the PDF representation of this PdfArray.

Overrides:
toPdf in class PdfObject
Returns:
an array of bytes
IOException

getArrayList

public ArrayList getArrayList()
Returns an ArrayList containing PdfObjects.

Returns:
an ArrayList

size

public int size()
Returns the number of entries in the array.

Returns:
the size of the ArrayList

add

public boolean add(PdfObject object)
Adds a PdfObject to the PdfArray.

Parameters:
object - PdfObject to add
Returns:
true

add

public boolean add(float[] values)

add

public boolean add(int[] values)

addFirst

public void addFirst(PdfObject object)
Adds a PdfObject to the PdfArray.

The newly added object will be the first element in the ArrayList.

Parameters:
object - PdfObject to add

contains

public boolean contains(PdfObject object)
Checks if the PdfArray already contains a certain PdfObject.

Parameters:
object - PdfObject to check
Returns:
true