Package com.pdftools.toolbox.pdf

Class PageList

java.lang.Object

com.pdftools.toolbox.internal.NativeBase

com.pdftools.toolbox.internal.NativeObject

com.pdftools.toolbox.pdf.PageList

All Implemented Interfaces:

java.lang.Iterable<Page>, java.util.Collection<Page>, java.util.List<Page>

public class PageList
extends NativeObject
implements java.util.List<Page>

Method Summary

Modifier and Type	Method	Description
void	add(int index, Page element)	Not supported.
boolean	add(Page element)
boolean	addAll(int index, java.util.Collection<? extends Page> elements)
boolean	addAll(java.util.Collection<? extends Page> elements)
void	clear()	Not supported.
boolean	contains(java.lang.Object object)
boolean	containsAll(java.util.Collection<?> objects)
static PageList	copy(Document targetDocument, PageList pageList, PageCopyOptions options)	Copy a page list
Page	get(int index)
int	indexOf(java.lang.Object obj)
boolean	isEmpty()
java.util.Iterator<Page>	iterator()
int	lastIndexOf(java.lang.Object obj)
java.util.ListIterator<Page>	listIterator()
java.util.ListIterator<Page>	listIterator(int index)
Page	remove(int index)	Not supported.
boolean	remove(java.lang.Object object)	Not supported.
boolean	removeAll(java.util.Collection<?> objects)	Not supported.
boolean	retainAll(java.util.Collection<?> objects)	Not supported.
Page	set(int index, Page element)	Not supported.
int	size()
PageList	subList(int fromIndex, int toIndex)
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] array)

Methods inherited from class com.pdftools.toolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Method Detail

copy

public static PageList copy(Document targetDocument,
                            PageList pageList,
                            PageCopyOptions options)
                     throws java.io.IOException,
                            CorruptException,
                            ConformanceException

Copy a page list

Copy pages from an input document to the given targetDocument. The returned list is associated with the given target document but not yet part of it. It can be appended to the document's page list.

Parameters:

targetDocument - the output document with which the returned object is associated

pageList - a page list of a different document

options - the copy options

Returns:

the copied page list, associated with the target document.

Throws:

java.io.IOException - Error reading from the source document or writing to the target document

CorruptException - The source document is corrupt

ConformanceException - The conformance level of the source document is not compatible with the conformance level of the target document.

ConformanceException - The explicitly requested conformance level is PDF/A Level A (Conformance.PDF_A1_A, Conformance.PDF_A2_A, or Conformance.PDF_A3_A) and the copy option PageCopyOptions.getCopyLogicalStructure() is not set.

java.lang.IllegalArgumentException - if the targetDocument argument has already been closed

java.lang.IllegalArgumentException - if the targetDocument argument is read-only

java.lang.IllegalArgumentException - if the pageList object is not associated with an input document

java.lang.IllegalArgumentException - if the document associated with pageList has already been closed

java.lang.IllegalArgumentException - if the argument options has PageCopyOptions.getFormFields() set to forms.FormFieldCopyStrategy.COPY and the targetDocument contains form fields that have either been copied explicitly with forms.FieldNode.copy or created with forms.CheckBox.create, forms.ComboBox.create, forms.CombTextField.create, forms.GeneralTextField.create, forms.ListBox.create, forms.RadioButtonGroup.create, or forms.SubForm.create.

java.lang.IllegalArgumentException - if the argument options has PageCopyOptions.getUnsignedSignatures() set to CopyStrategy.COPY and the targetDocument contains form fields that have either been copied explicitly with forms.FieldNode.copy or created with forms.CheckBox.create, forms.ComboBox.create, forms.CombTextField.create, forms.GeneralTextField.create, forms.ListBox.create, forms.RadioButtonGroup.create, or forms.SubForm.create.

java.lang.IllegalArgumentException - if options has PageCopyOptions.getCopyOutlineItems() set to true and the targetDocument contains outline items that have been copied explicitly with navigation.OutlineItem.copy.

java.lang.IllegalArgumentException - if targetDocument is null

java.lang.IllegalArgumentException - if pageList is null

addAll

public boolean addAll(java.util.Collection<? extends Page> elements)

Specified by:

addAll in interface java.util.Collection<Page>

Specified by:

addAll in interface java.util.List<Page>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends Page> elements)

Specified by:

addAll in interface java.util.List<Page>

contains

public boolean contains(java.lang.Object object)

Specified by:

contains in interface java.util.Collection<Page>

Specified by:

contains in interface java.util.List<Page>

containsAll

public boolean containsAll(java.util.Collection<?> objects)

Specified by:

containsAll in interface java.util.Collection<Page>

Specified by:

containsAll in interface java.util.List<Page>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<Page>

Specified by:

isEmpty in interface java.util.List<Page>

iterator

public java.util.Iterator<Page> iterator()

Specified by:

iterator in interface java.util.Collection<Page>

Specified by:

iterator in interface java.lang.Iterable<Page>

Specified by:

iterator in interface java.util.List<Page>

listIterator

public java.util.ListIterator<Page> listIterator()

Specified by:

listIterator in interface java.util.List<Page>

listIterator

public java.util.ListIterator<Page> listIterator(int index)

Specified by:

listIterator in interface java.util.List<Page>

remove

public boolean remove(java.lang.Object object)

Not supported.

Specified by:

remove in interface java.util.Collection<Page>

Specified by:

remove in interface java.util.List<Page>

removeAll

public boolean removeAll(java.util.Collection<?> objects)

Not supported.

Specified by:

removeAll in interface java.util.Collection<Page>

Specified by:

removeAll in interface java.util.List<Page>

retainAll

public boolean retainAll(java.util.Collection<?> objects)

Not supported.

Specified by:

retainAll in interface java.util.Collection<Page>

Specified by:

retainAll in interface java.util.List<Page>

subList

public PageList subList(int fromIndex,
                        int toIndex)

Specified by:

subList in interface java.util.List<Page>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<Page>

Specified by:

toArray in interface java.util.List<Page>

toArray

public <T> T[] toArray(T[] array)

Specified by:

toArray in interface java.util.Collection<Page>

Specified by:

toArray in interface java.util.List<Page>

size

public int size()

Specified by:

size in interface java.util.Collection<Page>

Specified by:

size in interface java.util.List<Page>

clear

public void clear()

Not supported.

Specified by:

clear in interface java.util.Collection<Page>

Specified by:

clear in interface java.util.List<Page>

indexOf

public int indexOf(java.lang.Object obj)

Specified by:

indexOf in interface java.util.List<Page>

lastIndexOf

public int lastIndexOf(java.lang.Object obj)

Specified by:

lastIndexOf in interface java.util.List<Page>

add

public boolean add(Page element)

Specified by:

add in interface java.util.Collection<Page>

Specified by:

add in interface java.util.List<Page>

add

public void add(int index,
                Page element)

Not supported.

Specified by:

add in interface java.util.List<Page>

get

public Page get(int index)

Specified by:

get in interface java.util.List<Page>

remove

public Page remove(int index)

Not supported.

Specified by:

remove in interface java.util.List<Page>

set

public Page set(int index,
                Page element)

Not supported.

Specified by:

set in interface java.util.List<Page>