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>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PdfTargetDictionary(PdfDictionary pdfObject)
PdfTargetDictionary(PdfName r)
PdfTargetDictionary(PdfName r, PdfString n, PdfObject p, PdfObject a, PdfTargetDictionary t)

Method Summary

Modifier and Type	Method and Description
PdfObject	getAnnotation()
PdfString	getName() Gets name of the file
PdfObject	getPage() Get the page number or a named destination that provides the page number containing the file attachment annotation
PdfTargetDictionary	getTarget()
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)
PdfTargetDictionary	setAnnotation(int annotNumber) Sets the index of the annotation in Annots array of the page specified by /P entry.
PdfTargetDictionary	setAnnotation(String annotationName) Sets the text value, which specifies the value of the /NM entry in the annotation dictionary.
PdfTargetDictionary	setName(String name) Sets the name of the file in the EmbeddedFiles name tree.
PdfTargetDictionary	setPage(int pageNumber) Sets the page number in the current document containing the 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.
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, 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)

PdfTargetDictionary

public PdfTargetDictionary(PdfName r)

PdfTargetDictionary

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

Method Detail

setName

public PdfTargetDictionary setName(String name)

Sets the name of the file in the EmbeddedFiles name tree.

Parameters:

name - the name of the file

Returns:

getName

public PdfString getName()

Gets name of the file

Returns:

setPage

public PdfTargetDictionary setPage(int pageNumber)

Sets the page number in the current document containing the file attachment annotation.

Parameters:

pageNumber -

Returns:

setPage

public PdfTargetDictionary setPage(String namedDestination)

Sets a named destination in the current document that provides the page number of the file attachment annotation.

Parameters:

namedDestination -

Returns:

getPage

public PdfObject getPage()

Get the page number or a named destination that provides the page number containing the file attachment annotation

Returns:

setAnnotation

public PdfTargetDictionary setAnnotation(int annotNumber)

Sets the index of the annotation in Annots array of the page specified by /P entry.

Parameters:

annotNumber -

Returns:

setAnnotation

public PdfTargetDictionary setAnnotation(String annotationName)

Sets the text value, which specifies the value of the /NM entry in the annotation dictionary.

Parameters:

annotationName -

Returns:

getAnnotation

public PdfObject getAnnotation()

setTarget

public PdfTargetDictionary setTarget(PdfTargetDictionary target)

Sets a target dictionary specifying additional path information to the target document.

Parameters:

target -

Returns:

getTarget

public PdfTargetDictionary getTarget()

put

public PdfTargetDictionary put(PdfName key,
                               PdfObject value)

isWrappedObjectMustBeIndirect

protected boolean isWrappedObjectMustBeIndirect()

Description copied from class: PdfObjectWrapper

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.