Java Doc for COSDocument.java in » PDF » jPod » de » intarsys » pdf » cos » 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.cos

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

de.intarsys.pdf.cos .COSDocument

COSDocument
public class COSDocument implements ICOSContainer,ICOSExceptionHandler,IAttributeSupport,ILocatorSupport(Code)
	This is a COS level representation of a pdf document. A COS document is made up of a collection of COSObject instances. These objects are arranged according to the PDF file format specification. See PDF File Format Specification [PDF].

Field Summary
final public static Object	SLOT_DIRTY
final public static Object	SLOT_LOCATOR
final public static Object	SLOT_TRAILER

Constructor Summary
protected	COSDocument() Create a new empty COSDocument.
protected	COSDocument(STDocument doc) Create a new COSDocument based on a STDocument.

Method Summary
public void	add(COSDocumentElement element) This should not be used by the application programmer.
public void	addDocumentListener(ICOSDocumentListener listener) Add an ICOSDocumentListener to be informed about the documents events.
public void	addMonitor(ICOSMonitor listener)
public ICOSContainer	associate(ICOSContainer newContainer, COSObject object) This method should not be used by the application programmer.
protected void	checkConsistency()
public void	close() Close the document.
public COSDocumentElement	containable(COSObject object) This method should not be used by the application programmer.
public COSDocument	copyDeep() Make a deep copy of the receiver.
public static COSDocument	createFromLocator(ILocator locator) Create a COSDocument based on a Locator. Parameters: locator - The ILocater referencing the documents data stream.
public static COSDocument	createFromST(STDocument doc) Create a COSDocument based on a STDocument. Parameters: doc - The storage layer document.
public static COSDocument	createNew() Create a new empty pdf COSDocument.
public static COSDocument	createNew(STDocType docType) Create a new empty COSDocument.
public ICOSContainer	disassociate(ICOSContainer oldContainer, COSObject object) This method should not be used by the application programmer.
public IAccessPermissions	getAccessPermissions() If a document contains a permissions dictionary, it is "pushed" to this by the parser.
public synchronized Object	getAttribute(Object key)
public COSCatalog	getCatalog() Get the root object (the catalog) for the document.
public COSDocument	getDoc() This method should not be used by the application programmer.
public int	getIncrementalCount() The number of versions created for this document so far.
public COSInfoDict	getInfoDict() Get the info dictionary containing metadata.
public ILocator	getLocator() The ILocator for this document.
public String	getName() The document name.
public EnumWriteMode	getWriteModeHint() The write mode to be used when the document is written the next time.
public void	handleException(COSRuntimeException ex)
protected void	initializeFromST()
protected void	initializeFromScratch()
public boolean	isDirty() Answer `true` if the document has changes to be commited.
public boolean	isEncrypted() Answer `true` if the document is encrypted.
public boolean	isNew() Answer `true` if the document is new, i.e.
public boolean	isReadOnly() Answer `true` if the document is read only.
public Iterator	objects() An iterator on all COSObject instances of this that are managed as indirect objects in the storage layer.
public int	referenceCount() This method should not be used by the application programmer.
public COSIndirectObject	referenceIndirect(COSObject object) This method should not be used by the application programmer.
public void	register(COSDocumentElement object) This method should not be used by the application programmer.
public synchronized Object	removeAttribute(Object key)
public void	removeDocumentListener(ICOSDocumentListener listener) Remove an ICOSDocumentListener .
public void	removeMonitor(ICOSMonitor monitor)
public void	restore(ILocator locator) Restore this from a locator.
public ICOSContainer	restoreStateContainer(ICOSContainer container) This method should not be used by the application programmer.
public void	save() Save the document to its current ILocator .
public void	save(ILocator locator) Save the document nto a new ILocator .
public void	save(ILocator locator, Map options) Save the document to an optional new ILocator using the `options` to control specific serializing behavior such as "incremental writing".
public ICOSContainer	saveStateContainer() This method should not be used by the application programmer.
protected void	setAccessPermissions(IAccessPermissions accessPermissions) Assign the IAccessPermissions for the document.
public synchronized Object	setAttribute(Object key, Object value)
protected void	setDirty(boolean b)
public void	setInfoDict(COSInfoDict infoDict) Set the info dictionary containing metadata.
public void	setName(String name) Assign a new name to the document.
public void	setWriteModeHint(EnumWriteMode writeMode) The write mode to be used when the document is written the next time.
public STDocument	stGetDoc() The storage layer document.
protected void	triggerChanged(Object slot, Object oldValue, Object newValue)
public void	triggerChangedAll() This method should not be used by the application programmer.
protected void	triggerChangedDirty()
protected void	triggerChangedLocator(Object oldValue, Object newValue)
public void	willChange(COSObject change) This method should not be used by the application programmer.

Field Detail

SLOT_DIRTY
final public static Object SLOT_DIRTY(Code)

SLOT_LOCATOR
final public static Object SLOT_LOCATOR(Code)

SLOT_TRAILER
final public static Object SLOT_TRAILER(Code)

Constructor Detail

COSDocument
protected COSDocument()(Code)
	Create a new empty COSDocument. This one does no initialization, use the factory method.

COSDocument
protected COSDocument(STDocument doc)(Code)
	Create a new COSDocument based on a STDocument. This one does no initialization, use the factory method. Parameters: storage - The storage level document

Method Detail

add
public void add(COSDocumentElement element)(Code)
	This should not be used by the application programmer. `public` for package visibility reasons. Parameters: element -

addDocumentListener
public void addDocumentListener(ICOSDocumentListener listener)(Code)
	Add an ICOSDocumentListener to be informed about the documents events. Parameters: listener - THe new listener

addMonitor
public void addMonitor(ICOSMonitor listener)(Code)

associate
public ICOSContainer associate(ICOSContainer newContainer, COSObject object)(Code)
	This method should not be used by the application programmer. This is called in the COSObject lifecycle to ensure internal consistency.

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 -

containable
public COSDocumentElement containable(COSObject object)(Code)
	This method should not be used by the application programmer. This is called in the COSObject lifecycle to ensure internal consistency.

copyDeep
public COSDocument copyDeep()(Code)
	Make a deep copy of the receiver. The newly created document has the same content as this, but does not share any object. The structure of the ST level is built from scratch. A deep copy of this.

createFromLocator
public static COSDocument createFromLocator(ILocator locator) throws IOException, COSLoadException(Code)
	Create a COSDocument based on a Locator. Parameters: locator - The ILocater referencing the documents data stream. A new COSDocument. throws: COSLoadException - throws: IOException -

createFromST
public static COSDocument createFromST(STDocument doc) throws COSLoadException(Code)
	Create a COSDocument based on a STDocument. Parameters: doc - The storage layer document. A new COSDocument. throws: COSLoadException -

createNew
public static COSDocument createNew()(Code)
	Create a new empty pdf COSDocument. A new empty pdf COSDocument

createNew
public static COSDocument createNew(STDocType docType)(Code)
	Create a new empty COSDocument. A new empty COSDocument

disassociate
public ICOSContainer disassociate(ICOSContainer oldContainer, COSObject object)(Code)
	This method should not be used by the application programmer. This is called in the COSObject lifecycle to ensure internal consistency.

getAccessPermissions
public IAccessPermissions getAccessPermissions()(Code)
	If a document contains a permissions dictionary, it is "pushed" to this by the parser. Otherwise the document will have full permissions set. The document access permissions

getAttribute
public synchronized Object getAttribute(Object key)(Code)

getCatalog
public COSCatalog getCatalog()(Code)
	Get the root object (the catalog) for the document. The root object (the catalog) for the document.

getDoc
public COSDocument getDoc()(Code)
	This method should not be used by the application programmer. This is called in the COSObject lifecycle to ensure internal consistency.

getIncrementalCount
public int getIncrementalCount()(Code)
	The number of versions created for this document so far. The number of versions created for this document so far.

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

getLocator
public ILocator getLocator()(Code)
	The ILocator for this document. The ILocator designates the physical storage for the PDF data. The ILocator for this document.

getName
public String getName()(Code)
	The document name. This is derived from the associated ILocator . The document name.

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.

handleException
public void handleException(COSRuntimeException ex) throws COSRuntimeException(Code)

initializeFromST
protected void initializeFromST()(Code)

initializeFromScratch
protected void initializeFromScratch()(Code)

isDirty
public boolean isDirty()(Code)
	Answer `true` if the document has changes to be commited. Answer `true` if the document has changes to becommited.

isEncrypted
public boolean isEncrypted()(Code)
	Answer `true` if the document is encrypted. Answer `true` if the document is encrypted.

isNew
public boolean isNew()(Code)
	Answer `true` if the document is new, i.e. not yet written. Answer `true` if the document is new, i.e. not yetwritten.

isReadOnly
public boolean isReadOnly()(Code)
	Answer `true` if the document is read only. To save the document and its changes you have to define another ILocator when saving. Answer `true` if the document is read only.

objects
public Iterator objects()(Code)
	An iterator on all COSObject instances of this that are managed as indirect objects in the storage layer. ATTENTION: This iterator may (and on incremental documents most often will) return objects that are no longer used (referenced) in the document. An iterator on all COSObject instances od this that are managedas indirect objects in the storage layer.

referenceCount
public int referenceCount()(Code)
	This method should not be used by the application programmer. This is called in the COSObject lifecycle to ensure internal consistency.

referenceIndirect
public COSIndirectObject referenceIndirect(COSObject object)(Code)
	This method should not be used by the application programmer. This is called in the COSObject lifecycle to ensure internal consistency.

register
public void register(COSDocumentElement object)(Code)
	This method should not be used by the application programmer. This is called in the COSObject lifecycle to ensure internal consistency.

removeAttribute
public synchronized Object removeAttribute(Object key)(Code)

removeDocumentListener
public void removeDocumentListener(ICOSDocumentListener listener)(Code)
	Remove an ICOSDocumentListener . Parameters: listener - The listener to be removed

removeMonitor
public void removeMonitor(ICOSMonitor monitor)(Code)

restore
public void restore(ILocator locator) throws IOException, COSLoadException(Code)
	Restore this from a locator. The ILocator must reference a data stream that was previously used to parse the document. Parameters: locator - The ILocator defining the new physical content. throws: IOException - throws: COSLoadException -

restoreStateContainer
public ICOSContainer restoreStateContainer(ICOSContainer container)(Code)
	This method should not be used by the application programmer. This is called in the COSObject lifecycle to ensure internal consistency.

save
public void save() throws IOException(Code)
	Save the document to its current ILocator . throws: IOException -

save
public void save(ILocator locator) throws IOException(Code)
	Save the document nto a new ILocator . Parameters: locator - The ILocator defining the new data location. throws: IOException -

save
public void save(ILocator locator, Map options) throws IOException(Code)
	Save the document to an optional new ILocator using the `options` to control specific serializing behavior such as "incremental writing". Parameters: locator - Parameters: options - throws: IOException -

saveStateContainer
public ICOSContainer saveStateContainer()(Code)
	This method should not be used by the application programmer. This is called in the COSObject lifecycle to ensure internal consistency.

setAccessPermissions
protected void setAccessPermissions(IAccessPermissions accessPermissions)(Code)
	Assign the IAccessPermissions for the document. Parameters: accessPermissions - The new IAccessPermissions.

setAttribute
public synchronized Object setAttribute(Object key, Object value)(Code)

setDirty
protected void setDirty(boolean b)(Code)

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

setName
public void setName(String name)(Code)
	Assign a new name to the document. Parameters: name - The new name.

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.

stGetDoc
public STDocument stGetDoc()(Code)
	The storage layer document. The storage layer document.

triggerChanged
protected void triggerChanged(Object slot, Object oldValue, Object newValue)(Code)

triggerChangedAll
public void triggerChangedAll()(Code)
	This method should not be used by the application programmer. This is called in the COSObject lifecycle to ensure internal consistency.

triggerChangedDirty
protected void triggerChangedDirty()(Code)

triggerChangedLocator
protected void triggerChangedLocator(Object oldValue, Object newValue)(Code)

willChange
public void willChange(COSObject change)(Code)
	This method should not be used by the application programmer. This is called in the COSObject lifecycle to ensure internal consistency.

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.