Java Doc for PDDocument.java in » PDF » jPod » de » intarsys » pdf » pd » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » PDF » jPod » de.intarsys.pdf.pd

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

de.intarsys.pdf.pd .PDDocument

PDDocument
public class PDDocument implements IAdditionalActionSupport,IAttributeSupport,ILocatorSupport(Code)
	The PD Level representation of a PDF Document. PD Level objects provide the PDF semantics on top of the COS objects. A PDDocument object should not be shared between threads without thought. Some clients may store information along with the PDDocument extensions in a non thread safe manner.

Field Summary
final public static Set	CATALOG_ACTION_TRIGGERS
final public static COSName	CN_Perms_DocMDP
final public static COSName	CN_Perms_UR
final public static COSName	DK_OpenAction
final public static COSName	DK_Perms

Constructor Summary
protected	PDDocument()
protected	PDDocument(COSDocument newDoc) PDDocument constructor.

Method Summary
public void	addAction(PDAction action)
public void	addOpenAction(PDAction newAction) Add a PDAction to be exceuted when this is opened.
public void	addPageNode(PDPageNode newNode) Add a page object to this documents root page tree.
public void	addPageNodeAfter(PDPageNode newNode, PDPageNode destination) Add a page object to this document after the designated page.
protected void	checkConsistency()
public void	close() Close the document.
protected void	collectAnnotations(List result)
public PDDocument	copyDeep() Make a deep copy of the receiver.
public COSDocument	cosGetDoc()
public COSDictionary	cosGetPermissionsDict() The permissions dictionary of the document.
public COSDictionary	cosGetPieceInfoDict() The piece info dictionary of the document.
public COSDictionary	cosGetURI() The uri dictionary of the document.
public void	cosSetPermissionsDict(COSDictionary permsDict) Set the permissions dictionary of the document.
public void	cosSetPieceInfoDict(COSDictionary dict) Set the piece info dictionary of the document.
public PDAcroForm	createAcroForm() create an AcroForm in a PDF Document.
public static PDDocument	createFromCos(COSDocument doc)
public static PDDocument	createFromLocator(ILocator locator)
public static PDDocument	createNew()
public PDPageTree	createPageTree() create a new page tree for this document.
public IAccessPermissions	getAccessPermissions()
public PDAcroForm	getAcroForm() read an AcroForm from a PDF Document.
public PDAdditionalActions	getAdditionalActions()
public List	getAnnotations()
public PDApplicationData	getApplicationData(String name)
public Object	getAttribute(Object key)
public String	getAuthor()
public COSCatalog	getCatalog()
public CDSDate	getCreationDate()
public String	getCreationDateString()
public String	getCreator()
protected String	getDocumentInfoString(COSName name)
public COSInfoDict	getInfoDict() Get the info dictionary containing metadata.
public String	getKeywords()
public ILocator	getLocator()
public String	getMetadata()
public CDSDate	getModDate()
public String	getModDateString()
public String	getName()
public PDAction	getOpenAction()
public PDOutline	getOutline()
public PDOutputIntent	getOutputIntent(COSName oiName)
public List	getOutputIntents()
public PDPageTree	getPageTree()
public PDSignature	getPermissions(COSName key) Shortcut to a signature dictionary in the document permissions dictionary.
public String	getProducer()
public String	getSubject()
public Set	getSupportedTriggerEvents()
public String	getTitle()
public String	getTrapped()
public EnumWriteMode	getWriteModeHint() The write mode to be used when the document is written the next time.
protected void	initializeFromCos()
protected void	initializeFromScratch()
public boolean	isAppendOnly() `true` if the document has a flag to prefere incremental save.
public boolean	isDirty()
public boolean	isEncrypted() Lookup if this document is encrypted, means it has a security handler.
public boolean	isNew()
public boolean	isPreferIncrementalSave() `true` if the document should be saved in an incremental way only.
public boolean	isReadOnly()
public boolean	isSigned() `true` if the document contains digital signatures.
public COSObject	lookupDestination(String name)
public void	removeApplicationData(String name)
public Object	removeAttribute(Object key)
public void	restore(ILocator locator)
public void	save()
public void	save(ILocator locator)
public void	save(ILocator locator, Map options)
public void	setAcroForm(PDAcroForm form) Set AcroForm in PDF Document.
public void	setAdditionalActions(PDAdditionalActions actions)
public void	setApplicationData(String name, PDApplicationData data)
public Object	setAttribute(Object key, Object o)
public void	setAuthor(String value)
public void	setCreationDateString(String value)
public void	setCreator(String value)
public void	setDocumentInfo(COSName name, String value)
public void	setInfoDict(COSInfoDict infoDict) Set the info dictionary containing metadata.
public void	setKeywords(String value)
public void	setModDateString(String value)
public void	setName(String name)
public void	setOpenAction(PDAction newAction)
public void	setOutline(PDOutline outline)
public void	setPageTree(PDPageTree newTree)
public void	setPermissions(COSName name, PDSignature signature)
public void	setProducer(String value)
public void	setSubject(String value)
public void	setTitle(String value)
public void	setTrapped(String value)
public void	setWriteModeHint(EnumWriteMode writeMode) The write mode to be used when the document is written the next time.

Field Detail

CATALOG_ACTION_TRIGGERS
final public static Set CATALOG_ACTION_TRIGGERS(Code)

CN_Perms_DocMDP
final public static COSName CN_Perms_DocMDP(Code)

CN_Perms_UR
final public static COSName CN_Perms_UR(Code)

DK_OpenAction
final public static COSName DK_OpenAction(Code)

DK_Perms
final public static COSName DK_Perms(Code)

Constructor Detail

PDDocument
protected PDDocument()(Code)

PDDocument
protected PDDocument(COSDocument newDoc)(Code)
	PDDocument constructor. Parameters: newDoc - The COS document representing the receiver.

Method Detail

addAction
public void addAction(PDAction action)(Code)

addOpenAction
public void addOpenAction(PDAction newAction)(Code)
	Add a PDAction to be exceuted when this is opened. Parameters: newAction - The new PDAction

addPageNode
public void addPageNode(PDPageNode newNode)(Code)
	Add a page object to this documents root page tree. Parameters: newNode - The page to be added

addPageNodeAfter
public void addPageNodeAfter(PDPageNode newNode, PDPageNode destination)(Code)
	Add a page object to this document after the designated page. Parameters: newNode - the page to be added Parameters: destination - The page after the new one is inserted

checkConsistency
protected void checkConsistency() throws COSLoadError(Code)

close
public void close() throws IOException(Code)
	Close the document. Accessing a documents content is undefined after `close`. throws: IOException -

collectAnnotations
protected void collectAnnotations(List result)(Code)

copyDeep
public PDDocument copyDeep()(Code)
	Make a deep copy of the receiver. the object copied recursively

cosGetDoc
public COSDocument cosGetDoc()(Code)
	The COS level implementation of the document The underlying COSDocument

cosGetPermissionsDict
public COSDictionary cosGetPermissionsDict()(Code)
	The permissions dictionary of the document. The permissions dictionary of the document.

cosGetPieceInfoDict
public COSDictionary cosGetPieceInfoDict()(Code)
	The piece info dictionary of the document. The piece info dictionary of the document.

cosGetURI
public COSDictionary cosGetURI()(Code)
	The uri dictionary of the document. The uri dictionary of the document.

cosSetPermissionsDict
public void cosSetPermissionsDict(COSDictionary permsDict)(Code)
	Set the permissions dictionary of the document. Parameters: permsDict - the new permission dictionary

cosSetPieceInfoDict
public void cosSetPieceInfoDict(COSDictionary dict)(Code)
	Set the piece info dictionary of the document. Parameters: dict - the new piece info dictionary

createAcroForm
public PDAcroForm createAcroForm()(Code)
	create an AcroForm in a PDF Document. the acro form just created throws: IllegalStateException -

createFromCos
public static PDDocument createFromCos(COSDocument doc) throws COSLoadException(Code)
	create a pd document based on a cos level object Parameters: doc - COSDocument to base this PDDocument on A new PDDocument object. throws: COSLoadException -

createFromLocator
public static PDDocument createFromLocator(ILocator locator) throws IOException, COSLoadException(Code)

createNew
public static PDDocument createNew()(Code)
	create a PDDocument from scratch A new PDDocument.

createPageTree
public PDPageTree createPageTree()(Code)
	create a new page tree for this document. tha page tree must still be added to the document or a page tree to get visible. the PDPageTree created

getAccessPermissions
public IAccessPermissions getAccessPermissions()(Code)
	Simple delegate to COSDocument.getAccessPermissions() document access permissions

getAcroForm
public PDAcroForm getAcroForm()(Code)
	read an AcroForm from a PDF Document. return null if no AcroForm is available. the acro form of the document or null

getAdditionalActions
public PDAdditionalActions getAdditionalActions()(Code)

getAnnotations
public List getAnnotations()(Code)

getApplicationData
public PDApplicationData getApplicationData(String name)(Code)

getAttribute
public Object getAttribute(Object key)(Code)

getAuthor
public String getAuthor()(Code)

getCatalog
public COSCatalog getCatalog()(Code)
	lookup the catalog dictionary in a document the document catalog object

getCreationDate
public CDSDate getCreationDate()(Code)

getCreationDateString
public String getCreationDateString()(Code)

getCreator
public String getCreator()(Code)

getDocumentInfoString
protected String getDocumentInfoString(COSName name)(Code)

getInfoDict
public COSInfoDict getInfoDict()(Code)
	Get the info dictionary containing metadata. The info dictionary containing metadata.

getKeywords
public String getKeywords()(Code)

getLocator
public ILocator getLocator()(Code)

getMetadata
public String getMetadata()(Code)

getModDate
public CDSDate getModDate()(Code)

getModDateString
public String getModDateString()(Code)

getName
public String getName()(Code)

getOpenAction
public PDAction getOpenAction()(Code)

getOutline
public PDOutline getOutline()(Code)

getOutputIntent
public PDOutputIntent getOutputIntent(COSName oiName)(Code)

getOutputIntents
public List getOutputIntents()(Code)

getPageTree
public PDPageTree getPageTree()(Code)
	return the documents root page tree the root page tree of the document

getPermissions
public PDSignature getPermissions(COSName key)(Code)
	Shortcut to a signature dictionary in the document permissions dictionary. Valid keys are "DocMDP" and "UR". If the permissions dictionary doesn't exist, then null is returned. If no signature dictionary under the specified key exists, null is returned. Parameters: key - key which should be ether "DocMDP" or "UR" returns a signature dictionary referenced by the specified key ornull if ether no permissions dictionary exists or no signaturedictionary to the key exists.

getProducer
public String getProducer()(Code)

getSubject
public String getSubject()(Code)

getSupportedTriggerEvents
public Set getSupportedTriggerEvents()(Code)

getTitle
public String getTitle()(Code)

getTrapped
public String getTrapped()(Code)

getWriteModeHint
public EnumWriteMode getWriteModeHint()(Code)
	The write mode to be used when the document is written the next time. If defined this overrides any hint that is used when saving the document. The write mode is reset after each "save". The write mode to be used when the document is written.

initializeFromCos
protected void initializeFromCos()(Code)
	initialize the object when created based on its cos representation

initializeFromScratch
protected void initializeFromScratch()(Code)
	initialize the object when created from scratch (in memory)

isAppendOnly
public boolean isAppendOnly()(Code)
	`true` if the document has a flag to prefere incremental save. `true` if the document should be saved in anincremental way only.

isDirty
public boolean isDirty()(Code)

isEncrypted
public boolean isEncrypted()(Code)
	Lookup if this document is encrypted, means it has a security handler. true if the document has an ISystemSecurityHandler

isNew
public boolean isNew()(Code)

isPreferIncrementalSave
public boolean isPreferIncrementalSave()(Code)
	`true` if the document should be saved in an incremental way only. This is for example the case when the document contains digital signatures. `true` if the document should be saved in anincremental way only.

isReadOnly
public boolean isReadOnly()(Code)

isSigned
public boolean isSigned()(Code)
	`true` if the document contains digital signatures. This should be reflected in the SigFlags entry of the form - but who knows... `true` if the document contains digital signatures.

lookupDestination
public COSObject lookupDestination(String name)(Code)

removeApplicationData
public void removeApplicationData(String name)(Code)

removeAttribute
public Object removeAttribute(Object key)(Code)

restore
public void restore(ILocator locator) throws IOException, COSLoadException(Code)

save
public void save() throws IOException(Code)

save
public void save(ILocator locator) throws IOException(Code)

save
public void save(ILocator locator, Map options) throws IOException(Code)

setAcroForm
public void setAcroForm(PDAcroForm form)(Code)
	Set AcroForm in PDF Document.

setAdditionalActions
public void setAdditionalActions(PDAdditionalActions actions)(Code)

setApplicationData
public void setApplicationData(String name, PDApplicationData data)(Code)

setAttribute
public Object setAttribute(Object key, Object o)(Code)

setAuthor
public void setAuthor(String value)(Code)

setCreationDateString
public void setCreationDateString(String value)(Code)

setCreator
public void setCreator(String value)(Code)

setDocumentInfo
public void setDocumentInfo(COSName name, String value)(Code)

setInfoDict
public void setInfoDict(COSInfoDict infoDict)(Code)
	Set the info dictionary containing metadata. Parameters: infoDict - The info dictionary containing metadata.

setKeywords
public void setKeywords(String value)(Code)

setModDateString
public void setModDateString(String value)(Code)

setName
public void setName(String name)(Code)

setOpenAction
public void setOpenAction(PDAction newAction)(Code)

setOutline
public void setOutline(PDOutline outline)(Code)

setPageTree
public void setPageTree(PDPageTree newTree)(Code)

setPermissions
public void setPermissions(COSName name, PDSignature signature)(Code)

setProducer
public void setProducer(String value)(Code)

setSubject
public void setSubject(String value)(Code)

setTitle
public void setTitle(String value)(Code)

setTrapped
public void setTrapped(String value)(Code)

setWriteModeHint
public void setWriteModeHint(EnumWriteMode writeMode)(Code)
	The write mode to be used when the document is written the next time. If defined this overrides any hint that is used when saving the document. The write mode is reset after each "save". Parameters: writeMode - The write mode to be used when the document is written.

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.