Package com.aowagie.text.pdf
Class PdfArray
- java.lang.Object
-
- com.aowagie.text.pdf.PdfObject
-
- com.aowagie.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.7' section 3.2.5 (page 58).- See Also:
PdfObject
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.ArrayList
arrayList
this is the actual array of PdfObjects-
Fields inherited from class com.aowagie.text.pdf.PdfObject
ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type
-
-
Constructor Summary
Constructors Constructor Description PdfArray()
Constructs an emptyPdfArray
-object.PdfArray(float[] values)
Constructs aPdfArray
-object, containing allfloat
values in a specified array.PdfArray(int[] values)
Constructs aPdfArray
-object, containing allint
values in a specified array.PdfArray(PdfArray array)
Constructs anPdfArray
-object, containing allPdfObject
s in a specifiedPdfArray
.PdfArray(PdfObject object)
Constructs anPdfArray
-object, containing 1PdfObject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(float[] values)
Adds an array offloat
values to end of thePdfArray
.boolean
add(int[] values)
Adds an array ofint
values to end of thePdfArray
.(package private) void
add(int index, PdfObject element)
Inserts the specified element at the specified position.boolean
add(PdfObject object)
Adds aPdfObject
to the end of thePdfArray
.void
addFirst(PdfObject object)
Inserts aPdfObject
at the beginning of thePdfArray
.(package private) boolean
contains(PdfObject object)
Checks if thePdfArray
already contains a certainPdfObject
.java.util.ArrayList
getArrayList()
Get the internal arrayList for this PdfArray.(package private) PdfDictionary
getAsDict(int idx)
Returns aPdfObject
as aPdfDictionary
, resolving indirect references.(package private) PdfIndirectReference
getAsIndirectObject(int idx)
Returns aPdfObject
as aPdfIndirectReference
.PdfName
getAsName(int idx)
Returns aPdfObject
as aPdfName
, resolving indirect references.PdfNumber
getAsNumber(int idx)
Returns aPdfObject
as aPdfNumber
, resolving indirect references.(package private) PdfString
getAsString(int idx)
Returns aPdfObject
as aPdfString
, resolving indirect references.(package private) PdfObject
getDirectObject(int idx)
Returns thePdfObject
with the specified index, resolving a possible indirect reference to a direct object.PdfObject
getPdfObject(int idx)
Returns thePdfObject
with the specified index.boolean
isEmpty()
Returnstrue
if the array is empty.java.util.ListIterator<PdfObject>
listIterator()
Returns the list iterator for the array.(package private) PdfObject
remove(int idx)
Remove the element at the specified position from the array.(package private) PdfObject
set(int idx, PdfObject obj)
Overwrites a specified location of the array, returning the previous valueint
size()
Returns the number of entries in the array.void
toPdf(PdfWriter writer, java.io.OutputStream os)
Writes the PDF representation of thisPdfArray
as an array ofbyte
to the specifiedOutputStream
.java.lang.String
toString()
Returns a string representation of thisPdfArray
.-
Methods inherited from class com.aowagie.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, setContent, setIndRef, type
-
-
-
-
Constructor Detail
-
PdfArray
public PdfArray()
Constructs an emptyPdfArray
-object.
-
PdfArray
public PdfArray(PdfObject object)
Constructs anPdfArray
-object, containing 1PdfObject
.- Parameters:
object
- aPdfObject
that has to be added to the array
-
PdfArray
PdfArray(float[] values)
Constructs aPdfArray
-object, containing allfloat
values in a specified array. Thefloat
values are internally converted toPdfNumber
objects.- Parameters:
values
- an array offloat
values to be added
-
PdfArray
PdfArray(int[] values)
Constructs aPdfArray
-object, containing allint
values in a specified array. Theint
values are internally converted toPdfNumber
objects.- Parameters:
values
- an array ofint
values to be added
-
PdfArray
PdfArray(PdfArray array)
Constructs anPdfArray
-object, containing allPdfObject
s in a specifiedPdfArray
.- Parameters:
array
- aPdfArray
to be added to the array
-
-
Method Detail
-
toPdf
public void toPdf(PdfWriter writer, java.io.OutputStream os) throws java.io.IOException
Writes the PDF representation of thisPdfArray
as an array ofbyte
to the specifiedOutputStream
.
-
toString
public java.lang.String toString()
Returns a string representation of thisPdfArray
. The string representation consists of a list of allPdfObject
s contained in thisPdfArray
, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space).
-
set
PdfObject set(int idx, PdfObject obj)
Overwrites a specified location of the array, returning the previous value- Parameters:
idx
- The index of the element to be overwrittenobj
- new value for the specified index- Returns:
- the previous value
- Throws:
java.lang.IndexOutOfBoundsException
- if the specified position doesn't exist- Since:
- 2.1.5
-
remove
PdfObject remove(int idx)
Remove the element at the specified position from the array. Shifts any subsequent elements to the left (subtracts one from their indices).- Parameters:
idx
- The index of the element to be removed.- Throws:
java.lang.IndexOutOfBoundsException
- the specified position doesn't exist- Since:
- 2.1.5
-
getArrayList
public java.util.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()
Returnstrue
if the array is empty.- Returns:
true
if the array is empty- Since:
- 2.1.5
-
add
public boolean add(PdfObject object)
Adds aPdfObject
to the end of thePdfArray
. ThePdfObject
will be the last element.- Parameters:
object
-PdfObject
to add- Returns:
- always
true
-
add
public boolean add(float[] values)
Adds an array offloat
values to end of thePdfArray
. The values will be the last elements. Thefloat
values are internally converted toPdfNumber
objects.- Parameters:
values
- An array offloat
values to add- Returns:
- always
true
-
add
public boolean add(int[] values)
Adds an array ofint
values to end of thePdfArray
. The values will be the last elements. Theint
values are internally converted toPdfNumber
objects.- Parameters:
values
- An array ofint
values to add- Returns:
- always
true
-
add
void add(int index, PdfObject element)
Inserts the specified element at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).- Parameters:
index
- The index at which the specified element is to be insertedelement
- The element to be inserted- Throws:
java.lang.IndexOutOfBoundsException
- if the specified index is larger than the last position currently set, plus 1.- Since:
- 2.1.5
-
addFirst
public void addFirst(PdfObject object)
Inserts aPdfObject
at the beginning of thePdfArray
. ThePdfObject
will be the first element, any other elements will be shifted to the right (adds one to their indices).- Parameters:
object
- ThePdfObject
to add
-
contains
boolean contains(PdfObject object)
Checks if thePdfArray
already contains a certainPdfObject
.- Parameters:
object
- ThePdfObject
to check- Returns:
true
-
listIterator
public java.util.ListIterator<PdfObject> listIterator()
Returns the list iterator for the array.- Returns:
- a ListIterator
-
getPdfObject
public PdfObject getPdfObject(int idx)
Returns thePdfObject
with the specified index. A possible indirect references is not resolved, so the returnedPdfObject
may be either a direct object or an indirect reference, depending on how the object is stored in thePdfArray
.- Parameters:
idx
- The index of thePdfObject
to be returned- Returns:
- A
PdfObject
-
getDirectObject
PdfObject getDirectObject(int idx)
Returns thePdfObject
with the specified index, resolving a possible indirect reference to a direct object. Thus this method will never return aPdfIndirectReference
object.- Parameters:
idx
- The index of thePdfObject
to be returned- Returns:
- A direct
PdfObject
ornull
-
getAsDict
PdfDictionary getAsDict(int idx)
Returns aPdfObject
as aPdfDictionary
, resolving indirect references. The object corresponding to the specified index is retrieved and resolvedto a direct object. If it is aPdfDictionary
, it is cast down and returned as such. Otherwisenull
is returned.- Parameters:
idx
- The index of thePdfObject
to be returned- Returns:
- the corresponding
PdfDictionary
object, ornull
-
getAsString
PdfString getAsString(int idx)
Returns aPdfObject
as aPdfString
, resolving indirect references. The object corresponding to the specified index is retrieved and resolved to a direct object. If it is aPdfString
, it is cast down and returned as such. Otherwisenull
is returned.- Parameters:
idx
- The index of thePdfObject
to be returned- Returns:
- the corresponding
PdfString
object, ornull
-
getAsNumber
public PdfNumber getAsNumber(int idx)
Returns aPdfObject
as aPdfNumber
, resolving indirect references. The object corresponding to the specified index is retrieved and resolved to a direct object. If it is aPdfNumber
, it is cast down and returned as such. Otherwisenull
is returned.- Parameters:
idx
- The index of thePdfObject
to be returned- Returns:
- the corresponding
PdfNumber
object, ornull
-
getAsName
public PdfName getAsName(int idx)
Returns aPdfObject
as aPdfName
, resolving indirect references. The object corresponding to the specified index is retrieved and resolved to a direct object. If it is aPdfName
, it is cast down and returned as such. Otherwisenull
is returned.- Parameters:
idx
- The index of thePdfObject
to be returned- Returns:
- the corresponding
PdfName
object, ornull
-
getAsIndirectObject
PdfIndirectReference getAsIndirectObject(int idx)
Returns aPdfObject
as aPdfIndirectReference
. The object corresponding to the specified index is retrieved. If it is aPdfIndirectReference
, it is cast down and returned as such. Otherwisenull
is returned.- Parameters:
idx
- The index of thePdfObject
to be returned- Returns:
- the corresponding
PdfIndirectReference
object, ornull
-
-