com.lowagie.text.pdf.collection

Class PdfTargetDictionary

public class PdfTargetDictionary extends PdfDictionary

Constructor Summary
PdfTargetDictionary(PdfTargetDictionary nested)
Creates dictionary referring to a target document that is the parent of the current document.
PdfTargetDictionary(boolean child)
Creates a dictionary referring to a target document.
Method Summary
voidsetAdditionalPath(PdfTargetDictionary nested)
If this dictionary refers to an intermediate target, you can add the next target in the sequence.
voidsetEmbeddedFileName(String target)
If this dictionary refers to a child that is a document level attachment, you need to specify the name that was used to attach the document.
voidsetFileAttachmentIndex(int annotation)
If this dictionary refers to a child that is a file attachment added to a page, you need to specify the page with setFileAttachmentPage or setFileAttachmentPageName, and then specify the index of the attachment added to this page (or use setFileAttachmentName).
voidsetFileAttachmentName(String name)
If this dictionary refers to a child that is a file attachment added to a page, you need to specify the page with setFileAttachmentPage or setFileAttachmentPageName, and then specify the name of the attachment added to this page (or use setFileAttachmentIndex).
voidsetFileAttachmentPage(int page)
If this dictionary refers to a child that is a file attachment added to a page, you need to specify the page number (or use setFileAttachmentPagename to specify a named destination).
voidsetFileAttachmentPagename(String name)
If this dictionary refers to a child that is a file attachment added to a page, you need to specify the name of the page (or use setFileAttachmentPage to specify the page number).

Constructor Detail

PdfTargetDictionary

public PdfTargetDictionary(PdfTargetDictionary nested)
Creates dictionary referring to a target document that is the parent of the current document.

Parameters: nested null if this is the actual target, another target if this is only an intermediate target.

PdfTargetDictionary

public PdfTargetDictionary(boolean child)
Creates a dictionary referring to a target document.

Parameters: child if false, this refers to the parent document; if true, this refers to a child document, and you'll have to specify where to find the child using the other methods of this class

Method Detail

setAdditionalPath

public void setAdditionalPath(PdfTargetDictionary nested)
If this dictionary refers to an intermediate target, you can add the next target in the sequence.

Parameters: nested the next target in the sequence

setEmbeddedFileName

public void setEmbeddedFileName(String target)
If this dictionary refers to a child that is a document level attachment, you need to specify the name that was used to attach the document.

Parameters: target the name in the EmbeddedFiles name tree

setFileAttachmentIndex

public void setFileAttachmentIndex(int annotation)
If this dictionary refers to a child that is a file attachment added to a page, you need to specify the page with setFileAttachmentPage or setFileAttachmentPageName, and then specify the index of the attachment added to this page (or use setFileAttachmentName).

Parameters: annotation the number of the attachment

setFileAttachmentName

public void setFileAttachmentName(String name)
If this dictionary refers to a child that is a file attachment added to a page, you need to specify the page with setFileAttachmentPage or setFileAttachmentPageName, and then specify the name of the attachment added to this page (or use setFileAttachmentIndex).

Parameters: name the name of the attachment

setFileAttachmentPage

public void setFileAttachmentPage(int page)
If this dictionary refers to a child that is a file attachment added to a page, you need to specify the page number (or use setFileAttachmentPagename to specify a named destination). Once you have specified the page, you still need to specify the attachment using another method.

Parameters: page the page number of the page with the file attachment.

setFileAttachmentPagename

public void setFileAttachmentPagename(String name)
If this dictionary refers to a child that is a file attachment added to a page, you need to specify the name of the page (or use setFileAttachmentPage to specify the page number). Once you have specified the page, you still need to specify the attachment using another method.

Parameters: name the named destination referring to the page with the file attachment.