com.itextpdf.kernel.pdf

Class PdfDocumentInfo

java.lang.Object

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

com.itextpdf.kernel.pdf.PdfDocumentInfo

All Implemented Interfaces:

Serializable

public class PdfDocumentInfo
extends PdfObjectWrapper<PdfDictionary>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PdfDocumentInfo(PdfDictionary pdfObject)
PdfDocumentInfo(PdfDictionary pdfObject, PdfDocument pdfDocument) Create a PdfDocumentInfo based on the passed PdfDictionary and linked to the passed PdfDocument.
PdfDocumentInfo(PdfDocument pdfDocument) Create a default, empty PdfDocumentInfo and link it to the passed PdfDocument

Method Summary

Modifier and Type	Method and Description
PdfDocumentInfo	addCreationDate()
PdfDocumentInfo	addModDate()
void	flush()
String	getAuthor()
String	getCreator()
String	getKeywords()
String	getProducer()
String	getSubject()
String	getTitle()
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.
PdfDocumentInfo	setAuthor(String author)
PdfDocumentInfo	setCreator(String creator)
PdfDocumentInfo	setKeywords(String keywords)
void	setMoreInfo(Map<String,String> moreInfo)
void	setMoreInfo(String key, String value)
PdfDocumentInfo	setSubject(String subject)
PdfDocumentInfo	setTitle(String title)

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

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, 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

PdfDocumentInfo

public PdfDocumentInfo(PdfDictionary pdfObject,
                       PdfDocument pdfDocument)

Create a PdfDocumentInfo based on the passed PdfDictionary and linked to the passed PdfDocument.

Parameters:

pdfObject - PdfDictionary containing PdfDocumentInfo

pdfDocument - PdfDocument the PdfDocumentInfo corresponds to.

PdfDocumentInfo

public PdfDocumentInfo(PdfDictionary pdfObject)

PdfDocumentInfo

public PdfDocumentInfo(PdfDocument pdfDocument)

Create a default, empty PdfDocumentInfo and link it to the passed PdfDocument

Parameters:

pdfDocument -

Method Detail

setTitle

public PdfDocumentInfo setTitle(String title)

setAuthor

public PdfDocumentInfo setAuthor(String author)

setSubject

public PdfDocumentInfo setSubject(String subject)

setKeywords

public PdfDocumentInfo setKeywords(String keywords)

setCreator

public PdfDocumentInfo setCreator(String creator)

getTitle

public String getTitle()

getAuthor

public String getAuthor()

getSubject

public String getSubject()

getKeywords

public String getKeywords()

getCreator

public String getCreator()

getProducer

public String getProducer()

addCreationDate

public PdfDocumentInfo addCreationDate()

addModDate

public PdfDocumentInfo addModDate()

setMoreInfo

public void setMoreInfo(Map<String,String> moreInfo)

setMoreInfo

public void setMoreInfo(String key,
                        String value)

flush

public void flush()

Overrides:

flush in class PdfObjectWrapper<PdfDictionary>

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.