com.itextpdf.kernel.pdf.action

Class PdfTargetDictionary

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.pdf.action.PdfTargetDictionary

All Implemented Interfaces:

Serializable

public class PdfTargetDictionary
extends PdfObjectWrapper<PdfDictionary>

A target dictionary locates the target in relation to the source, in much the same way that a relative path describes the physical relationship between two files in a file system. Target dictionaries may be nested recursively to specify one or more intermediate targets before reaching the final one.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PdfTargetDictionary(PdfDictionary pdfObject) Creates a new PdfTargetDictionary object by the underlying dictionary.
PdfTargetDictionary(PdfName r) Creates a new PdfTargetDictionary object given its type.
PdfTargetDictionary(PdfName r, PdfString n, PdfObject p, PdfObject a, PdfTargetDictionary t) Creates a new PdfTargetDictionary object.

Method Summary

Modifier and Type	Method and Description
static PdfTargetDictionary	createChildTarget(int pageNumber, int annotationIndex) Creates a new target object pointing to a file attachment annotation.
static PdfTargetDictionary	createChildTarget(String embeddedFileName) Creates a new target object pointing to a file in the EmbeddedFiles name tree.
static PdfTargetDictionary	createChildTarget(String namedDestination, String annotationIdentifier) Creates a new target object pointing to a file attachment annotation.
static PdfTargetDictionary	createParentTarget() Creates a new target object pointing to the parent of the current document.
PdfObject	getAnnotation() Gets the object in the /A entry of the underlying object.
PdfString	getName() Gets name of the file in the EmbeddedFiles name tree for the child target located in the EmbeddedFiles.
PdfObject	getPage() Get the contents of the /P entry of this target object.
PdfTargetDictionary	getTarget() Get a target dictionary specifying additional path information to the target document.
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.
PdfTargetDictionary	put(PdfName key, PdfObject value) This is a convenient method to put key-value pairs to the underlying PdfObject.
PdfTargetDictionary	setAnnotation(int annotationIndex) Sets the index of the annotation in Annots array of the page specified by /P entry for the child target associated with a file attachment annotation.
PdfTargetDictionary	setAnnotation(String annotationName) Sets the text value, which uniquely identifies an annotation (/NM entry) in an annotation dictionary for the child target associated with a file attachment annotation.
PdfTargetDictionary	setName(String name) Sets the name of the file in the EmbeddedFiles name tree for the child target located in the EmbeddedFiles.
PdfTargetDictionary	setPage(int pageNumber) Sets the page number in the current document containing the file attachment annotation for the child target associates with a file attachment annotation.
PdfTargetDictionary	setPage(String namedDestination) Sets a named destination in the current document that provides the page number of the file attachment annotation for the child target associated with a file attachment annotation.
PdfTargetDictionary	setTarget(PdfTargetDictionary target) Sets a target dictionary specifying additional path information to the target document.

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfTargetDictionary

public PdfTargetDictionary(PdfDictionary pdfObject)

Creates a new PdfTargetDictionary object by the underlying dictionary.

Parameters:

pdfObject - the underlying dictionary object

PdfTargetDictionary

public PdfTargetDictionary(PdfName r)

Creates a new PdfTargetDictionary object given its type. The type must be either PdfName.P, or PdfName.C. If it is PdfName.C, additional entries must be specified according to the spec.

Parameters:

r - the relationship between the current document and the target

PdfTargetDictionary

public PdfTargetDictionary(PdfName r,
                           PdfString n,
                           PdfObject p,
                           PdfObject a,
                           PdfTargetDictionary t)

Creates a new PdfTargetDictionary object.

Parameters:

r - the relationship between the current document and the target

n - the name of the file in the EmbeddedFiles name tree

p - if the value is an integer, it specifies the page number (zero-based) in the current document containing the file attachment annotation. If the value is a string, it specifies a named destination in the current document that provides the page number of the file attachment annotation

a - If the value is an integer, it specifies the index (zero-based) of the annotation in the Annots array of the page specified by P. If the value is a text string, it specifies the value of NM in the annotation dictionary

t - A target dictionary specifying additional path information to the target document. If this entry is absent, the current document is the target file containing the destination

Method Detail

createParentTarget

public static PdfTargetDictionary createParentTarget()

Creates a new target object pointing to the parent of the current document.

Returns:

created PdfTargetDictionary

createChildTarget

public static PdfTargetDictionary createChildTarget(String embeddedFileName)

Creates a new target object pointing to a file in the EmbeddedFiles name tree.

Parameters:

embeddedFileName - the name of the file in the EmbeddedFiles name tree

Returns:

created object

createChildTarget

public static PdfTargetDictionary createChildTarget(String namedDestination,
                                                    String annotationIdentifier)

Creates a new target object pointing to a file attachment annotation.

Parameters:

namedDestination - a named destination in the current document that provides the page number of the file attachment annotation

annotationIdentifier - a unique annotation identifier (PdfName.NM entry) of the annotation

Returns:

created object

createChildTarget

public static PdfTargetDictionary createChildTarget(int pageNumber,
                                                    int annotationIndex)

Creates a new target object pointing to a file attachment annotation.

Parameters:

pageNumber - the number of the page in the current document, one-based

annotationIndex - the index of the annotation in the Annots entry of the page, zero-based

Returns:

created object

setName

public PdfTargetDictionary setName(String name)

Sets the name of the file in the EmbeddedFiles name tree for the child target located in the EmbeddedFiles.

Parameters:

name - the name of the file

Returns:

this object wrapper

getName

public PdfString getName()

Gets name of the file in the EmbeddedFiles name tree for the child target located in the EmbeddedFiles.

Returns:

the name of the child file for this target

setPage

public PdfTargetDictionary setPage(int pageNumber)

Sets the page number in the current document containing the file attachment annotation for the child target associates with a file attachment annotation.

Parameters:

pageNumber - the page number (one-based) in the current document containing the file attachment annotation

Returns:

this object wrapper

setPage

public PdfTargetDictionary setPage(String namedDestination)

Sets a named destination in the current document that provides the page number of the file attachment annotation for the child target associated with a file attachment annotation.

Parameters:

namedDestination - a named destination in the current document that provides the page number of the file attachment annotation

Returns:

this object wrapper

getPage

public PdfObject getPage()

Get the contents of the /P entry of this target object. If the value is an integer, it specifies the page number (zero-based) in the current document containing the file attachment annotation. If the value is a string, it specifies a named destination in the current document that provides the page number of the file attachment annotation.

Returns:

the /P entry of target object

setAnnotation

public PdfTargetDictionary setAnnotation(int annotationIndex)

Sets the index of the annotation in Annots array of the page specified by /P entry for the child target associated with a file attachment annotation.

Parameters:

annotationIndex - the index (zero-based) of the annotation in the Annots array

Returns:

this object wrapper

setAnnotation

public PdfTargetDictionary setAnnotation(String annotationName)

Sets the text value, which uniquely identifies an annotation (/NM entry) in an annotation dictionary for the child target associated with a file attachment annotation.

Parameters:

annotationName - specifies the value of NM in the annotation dictionary of the target annotation

Returns:

this object wrapper

getAnnotation

public PdfObject getAnnotation()

Gets the object in the /A entry of the underlying object. If the value is an integer, it specifies the index (zero-based) of the annotation in the Annots array of the page specified by P. If the value is a text string, it specifies the value of NM in the annotation dictionary.

Returns:

the /A entry in the target object

setTarget

public PdfTargetDictionary setTarget(PdfTargetDictionary target)

Sets a target dictionary specifying additional path information to the target document. If this entry is absent, the current document is the target file containing the destination.

Parameters:

target - the additional path target dictionary

Returns:

this object wrapper

getTarget

public PdfTargetDictionary getTarget()

Get a target dictionary specifying additional path information to the target document. If the current target object is the final node in the target path, null is returned.

Returns:

a target dictionary specifying additional path information to the target document

put

public PdfTargetDictionary put(PdfName key,
                               PdfObject value)

This is a convenient method to put key-value pairs to the underlying PdfObject.

Parameters:

key - the key, a PdfName instance

value - the value

Returns:

this object wrapper

isWrappedObjectMustBeIndirect

protected boolean isWrappedObjectMustBeIndirect()

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Specified by:

isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfDictionary>

Returns:

true if in the resultant document the object behind the wrapper must be indirect, otherwise false.