public class

PDFDocInfo

extends Object
java.lang.Object
   ↳ com.pdftron.pdf.PDFDocInfo

Class Overview

PDFDocInfo is a high-level utility class that can be used to read and modify document's metadata.

Summary

Public Constructors
PDFDocInfo(Obj tr)
PDFDocInfo constructor.
Public Methods
String getAuthor()
Get the author.
Obj getAuthorObj()
Get the author SDF/Cos object.
Date getCreationDate()
Get the creation date.
String getCreator()
Get the creator.
Obj getCreatorObj()
Get the creator SDF/Cos object.
String getKeywords()
Get the keywords.
Obj getKeywordsObj()
Get the keywords SDF/Cos object.
Date getModDate()
Get the mod date.
String getProducer()
Get the producer.
Obj getProducerObj()
Get the producer SDF/Cos object.
Obj getSDFObj()
Get the SDF/Cos object.
String getSubject()
Get the subject.
Obj getSubjectObj()
Get the subject SDF/Cos object.
String getTitle()
Get the document title.
Obj getTitleObj()
Get the title SDF/Cos object.
void setAuthor(String author)
Set the author of the document.
void setCreationDate(Date creation_date)
Set document's creation date.
void setCreator(String creator)
Set document's creator.
void setKeywords(String keywords)
Set keywords associated with the document.
void setModDate(Date mod_date)
Set document's modification date.
void setProducer(String producer)
Set document's producer.
void setSubject(String subject)
Set the subject of the document.
void setTitle(String title)
Set document's title.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PDFDocInfo (Obj tr)

PDFDocInfo constructor. Typically this constructor is never used since it is easier to obtain DocInfo using PDFDoc.GetDocInfo()

Public Methods

public String getAuthor ()

Get the author.

Returns
  • The name of the person who created the document.
Throws
PDFNetException

public Obj getAuthorObj ()

Get the author SDF/Cos object.

Returns
  • SDF/Cos string object representing document's author.
Throws
PDFNetException

public Date getCreationDate ()

Get the creation date.

Returns
  • The date and time the document was created, in human-readable form.
Throws
PDFNetException

public String getCreator ()

Get the creator.

Returns
  • If the document was converted to PDF from another format, the name of the application that created the original document from which it was converted.
Throws
PDFNetException

public Obj getCreatorObj ()

Get the creator SDF/Cos object.

Returns
  • SDF/Cos string object representing document's creator.
Throws
PDFNetException

public String getKeywords ()

Get the keywords.

Returns
  • Keywords associated with the document.
Throws
PDFNetException

public Obj getKeywordsObj ()

Get the keywords SDF/Cos object.

Returns
  • SDF/Cos string object representing document's keywords.
Throws
PDFNetException

public Date getModDate ()

Get the mod date.

Returns
  • The date and time the document was most recently modified, in human-readable form.
Throws
PDFNetException

public String getProducer ()

Get the producer.

Returns
  • If the document was converted to PDF from another format, the name of the application (for example, Distiller) that converted it to PDF.
Throws
PDFNetException

public Obj getProducerObj ()

Get the producer SDF/Cos object.

Returns
  • SDF/Cos string object representing document's producer.
Throws
PDFNetException

public Obj getSDFObj ()

Get the SDF/Cos object.

Returns
  • document's SDF/Cos 'Info' dictionary or NULL if the info dictionary is not available.

public String getSubject ()

Get the subject.

Returns
  • The subject of the document.
Throws
PDFNetException

public Obj getSubjectObj ()

Get the subject SDF/Cos object.

Returns
  • SDF/Cos string object representing document's subject.
Throws
PDFNetException

public String getTitle ()

Get the document title.

Returns
  • The document's title.
Throws
PDFNetException

public Obj getTitleObj ()

Get the title SDF/Cos object.

Returns
  • SDF/Cos string object representing document's title.
Throws
PDFNetException

public void setAuthor (String author)

Set the author of the document.

Parameters
author the new author
Throws
PDFNetException

public void setCreationDate (Date creation_date)

Set document's creation date.

Parameters
creation_date The date and time the document was created.
Throws
PDFNetException

public void setCreator (String creator)

Set document's creator.

Parameters
creator The name of the application that created the original document.
Throws
PDFNetException

public void setKeywords (String keywords)

Set keywords associated with the document.

Parameters
keywords the new keywords
Throws
PDFNetException

public void setModDate (Date mod_date)

Set document's modification date.

Parameters
mod_date The date and time the document was most recently modified.
Throws
PDFNetException

public void setProducer (String producer)

Set document's producer.

Parameters
producer The name of the application that generated PDF.
Throws
PDFNetException

public void setSubject (String subject)

Set the subject of the document.

Parameters
subject The subject of the document.
Throws
PDFNetException

public void setTitle (String title)

Set document's title.

Parameters
title New title of the document.
Throws
PDFNetException