com.lowagie.text.pdf.collection: public class: PdfTargetDictionary

com.lowagie.text.pdf.collection
public class: PdfTargetDictionary [javadoc | source]

java.lang.Object
   com.lowagie.text.pdf.PdfObject
      com.lowagie.text.pdf.PdfDictionary
         com.lowagie.text.pdf.collection.PdfTargetDictionary

Fields inherited from com.lowagie.text.pdf.PdfDictionary:
FONT, OUTLINES, PAGE, PAGES, CATALOG, hashMap

Fields inherited from com.lowagie.text.pdf.PdfObject:
BOOLEAN, NUMBER, STRING, NAME, ARRAY, DICTIONARY, STREAM, NULL, INDIRECT, NOTHING, TEXT_PDFDOCENCODING, TEXT_UNICODE, bytes, type, indRef

Constructor:

Constructor:
public PdfTargetDictionary(PdfTargetDictionary nested) { super(); put(PdfName.R, PdfName.P); if (nested != null) setAdditionalPath(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.
public PdfTargetDictionary(boolean child) { super(); if (child) { put(PdfName.R, PdfName.C); } else { put(PdfName.R, PdfName.P); } } 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

 public PdfTargetDictionary(PdfTargetDictionary nested) {
		super();
		put(PdfName.R, PdfName.P);
		if (nested != null)
			setAdditionalPath(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.

 public PdfTargetDictionary(boolean child) {
		super();
		if (child) {
			put(PdfName.R, PdfName.C);
		}
		else {
			put(PdfName.R, PdfName.P);
		}
}

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 from com.lowagie.text.pdf.collection.PdfTargetDictionary Summary:
setAdditionalPath, setEmbeddedFileName, setFileAttachmentIndex, setFileAttachmentName, setFileAttachmentPage, setFileAttachmentPagename

Methods from com.lowagie.text.pdf.PdfDictionary:
contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString

Methods from com.lowagie.text.pdf.PdfObject:
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, toPdf, toString, type

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from com.lowagie.text.pdf.collection.PdfTargetDictionary Detail:
public void setAdditionalPath(PdfTargetDictionary nested) { put(PdfName.T, nested); } If this dictionary refers to an intermediate target, you can add the next target in the sequence.
public void setEmbeddedFileName(String target) { put(PdfName.N, new PdfString(target, null)); } 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.
public void setFileAttachmentIndex(int annotation) { put(PdfName.A, new PdfNumber(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).
public void setFileAttachmentName(String name) { put(PdfName.A, new PdfString(name, PdfObject.TEXT_UNICODE)); } 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).
public void setFileAttachmentPage(int page) { put(PdfName.P, new PdfNumber(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.
public void setFileAttachmentPagename(String name) { put(PdfName.P, new PdfString(name, null)); } 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.

Method from com.lowagie.text.pdf.collection.PdfTargetDictionary Detail:

 public  void setAdditionalPath(PdfTargetDictionary nested) {
		put(PdfName.T, nested);
}

If this dictionary refers to an intermediate target, you can add the next target in the sequence.

 public  void setEmbeddedFileName(String target) {
		put(PdfName.N, new PdfString(target, null));
}

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.

 public  void setFileAttachmentIndex(int annotation) {
		put(PdfName.A, new PdfNumber(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).

 public  void setFileAttachmentName(String name) {
		put(PdfName.A, new PdfString(name, PdfObject.TEXT_UNICODE));
}

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).

 public  void setFileAttachmentPage(int page) {
		put(PdfName.P, new PdfNumber(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.

 public  void setFileAttachmentPagename(String name) {
		put(PdfName.P, new PdfString(name, null));
}

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.