Java Doc for COSObject.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 .COSDocumentElement

de.intarsys.pdf.cos .COSObject

All known Subclasses:   de.intarsys.pdf.cos .COSPrimitiveObject,  de.intarsys.pdf.cos .COSCompositeObject,
COSObject
abstract public class COSObject extends COSDocumentElement implements ISaveStateSupport(Code)
Abstract superclass for all COS level object types

Field Summary
final public static ICOSContainer CONSTANT_CONTAINER
     This is the container for template objects.
final public static ICOSContainer NULL_CONTAINER
     This is the default container for non - contained objects.
final public static Object SLOT_CONTAINER

protected ICOSContainer container
     The optional back-reference to the object "containing" this if any (for example an array).

Constructor Summary
protected COSObject()

protected COSObject(COSObject object)
     Copy constructor for creating save state.

Method Summary
protected ICOSContainer addContainer(ICOSContainer newContainer)

abstract public void addObjectListener(ICOSObjectListener listener)
     Add a listener for object changes.
public COSArray asArray()

public COSBoolean asBoolean()

public COSDictionary asDictionary()

public COSFixed asFixed()

public COSInteger asInteger()

public COSName asName()

public COSNull asNull()

public COSNumber asNumber()

public COSStream asStream()

public COSString asString()

abstract public Iterator basicIterator()
     An iterator over contained objects and references.
protected void basicSetContainer(ICOSContainer newContainer)

abstract protected String basicToString()
     A string representation for the receiver.
public COSObject beConstant()
     Declare this to be a constant.
public COSIndirectObject beIndirect()
     Make an indirect object out of a direct one.
public COSDocumentElement containable()

abstract protected COSObject copyBasic()
     Create a new instance of the receiver that may be used as the base object for a copy.
abstract public COSObject copyDeep()
     Make a deep copy of the receiver within the same document.
abstract public COSObject copyDeep(Map copied)
     Make a deep copy of the receiver within the same document.
final public COSObject copyOptional()
     Make a copy of the receiver within the same document.
public COSObject copyShallow()
     Make a copy of the receiver.
protected COSDocumentElement copyShallowNested()

final public COSObject copySubGraph()
     Make a copy of the receiver within the same document.
The algorithm copies this along with all outgoing references (recursively) that themselve have a navigation path to this.
protected COSObject copySubGraph(Map copied)
     The implementation of de.intarsys.pdf.cos.COSObject.copySubGraph .
public COSObject dereference()
     return the real object.
public ICOSContainer getContainer()
     Answer the object that contains this.
public COSDocument getDoc()
     The document that contains this.
public COSIndirectObject getIndirectObject()
     return the indirect object for the receiver.
protected boolean hasNavigationPathTo(COSObject other)
     Answer true if the receiver has a navigation path to other.
Parameters:
  other - The object we search a path to from this.
public boolean isDangling()
     true if this object is not contained in a document directly or indirectly.
public boolean isIndirect()
     Answer true if this object is an indirect one.
public boolean isNull()

public boolean isNumber()

abstract public boolean isObjectListenerAvailable()
     true if an ICOSObjectListener is registered.
abstract public boolean isPrimitive()

public boolean isSwapped()

abstract public Iterator iterator()
     An iterator over contained objects.
protected ICOSContainer removeContainer(ICOSContainer oldContainer)

abstract public void removeObjectListener(ICOSObjectListener listener)
     Remove a listener for object changes.
public void restoreState(Object saveState)

public String stringValue()
     A string representation for the receiver.
public String toString()

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


Field Detail
CONSTANT_CONTAINER
final public static ICOSContainer CONSTANT_CONTAINER(Code)
This is the container for template objects. Template objects can be created static in the application and are copied behind the scenes when integrated in a document.

NULL_CONTAINER
final public static ICOSContainer NULL_CONTAINER(Code)
This is the default container for non - contained objects.

SLOT_CONTAINER
final public static Object SLOT_CONTAINER(Code)

container
protected ICOSContainer container(Code)
The optional back-reference to the object "containing" this if any (for example an array).
A literal object may only be contained once, an indirect referenced object is contained by the indirect reference

Constructor Detail
COSObject
protected COSObject()(Code)

COSObject
protected COSObject(COSObject object)(Code)
Copy constructor for creating save state.
Parameters:
  object - The original object.

Method Detail
addContainer
protected ICOSContainer addContainer(ICOSContainer newContainer)(Code)

addObjectListener
abstract public void addObjectListener(ICOSObjectListener listener)(Code)
Add a listener for object changes.
Parameters:
  listener - The listener to be informed about changes.

asArray
public COSArray asArray()(Code)
this as a COSArray or null a COSArray or null

asBoolean
public COSBoolean asBoolean()(Code)
a COSBoolean or null

asDictionary
public COSDictionary asDictionary()(Code)
a COSDictionary or null

asFixed
public COSFixed asFixed()(Code)
a COSFixed or null

asInteger
public COSInteger asInteger()(Code)
a COSInteger or null

asName
public COSName asName()(Code)
a COSName or null

asNull
public COSNull asNull()(Code)
a COSNull or null

asNumber
public COSNumber asNumber()(Code)
a COSNumber or null

asStream
public COSStream asStream()(Code)
a COSStream or null

asString
public COSString asString()(Code)
a COSString or null

basicIterator
abstract public Iterator basicIterator()(Code)
An iterator over contained objects and references. The iterator is an empty iterator if this is not a container.
This iterator returns COSDocumentElements, leaving references alone.
Iterator over contained objects and references.

basicSetContainer
protected void basicSetContainer(ICOSContainer newContainer)(Code)

basicToString
abstract protected String basicToString()(Code)
A string representation for the receiver. A string representation for the receiver.

beConstant
public COSObject beConstant()(Code)
Declare this to be a constant. This declaration ensures, that when using this in a document context a copy will be made. The receiver.

beIndirect
public COSIndirectObject beIndirect()(Code)
Make an indirect object out of a direct one. An object can always be changed to an indirect one.
It is possible to morph existing objects into indirect ones, the objects in the hierarchy (container/document) are informed and will reflect the change.

containable
public COSDocumentElement containable()(Code)

copyBasic
abstract protected COSObject copyBasic()(Code)
Create a new instance of the receiver that may be used as the base object for a copy. The result is an uninitialized instance of the receiver. The attributes are copied depending on the strategy (deep, shallow). The new instance of a COSObject

copyDeep
abstract public COSObject copyDeep()(Code)
Make a deep copy of the receiver within the same document. The result is a "PDF semantic" deep copy, implementation artifacts as "attributes" and listeners are NOT copied.
The algorithm copies this along with all outgoing references (recursively).

Object identity is preserved.

Be careful when copying objects, as there are semantics that may NOT be recognized by this method.
the object copied recursively

copyDeep
abstract public COSObject copyDeep(Map copied)(Code)
Make a deep copy of the receiver within the same document. The result is a "PDF semantic" deep copy, implementation artifacts as "attributes" and listeners are NOT copied.
The copied map is used to identify objects copied in earlier runs of this method to avoid duplicating resources used in different copy targets (for example the pages of a document). copied is modified while executing copyDeep and contains a mapping from indirect objects in the original document to copied objects.
The algorithm copies this along with all outgoing references (recursively).

Object identity is preserved.

Be careful when copying objects, as there are semantics that may NOT be recognized by this method.
the object copied recursively

copyOptional
final public COSObject copyOptional()(Code)
Make a copy of the receiver within the same document. A copy is made only if we have an object that may not be inserted in multiple containers. This means all direct objects are (recursively) copied, all indirect objects return the receiver.
Be careful when copying objects, as there are semantics that may NOT be recognized by this method.
The optional copy.

copyShallow
public COSObject copyShallow()(Code)
Make a copy of the receiver.
A copy is made of the receiver and after this recursively of all not indirect objects.

Be careful when copying objects, as there are semantics that may NOT be recognized by this method.
The object copied

copyShallowNested
protected COSDocumentElement copyShallowNested()(Code)

copySubGraph
final public COSObject copySubGraph()(Code)
Make a copy of the receiver within the same document.
The algorithm copies this along with all outgoing references (recursively) that themselve have a navigation path to this. The result is a new subgraph extending from the copy of this where no navigation path leads back to this.

Object identity is preserved.

Be careful when copying objects, as there are semantics that may NOT be recognized by this method.
the object copied recursively

copySubGraph
protected COSObject copySubGraph(Map copied)(Code)
The implementation of de.intarsys.pdf.cos.COSObject.copySubGraph . The parameters copiedkeeps track of already copied objects to deal with cyclic references.
See Also:   de.intarsys.pdf.cos.COSObject.copySubGraph

dereference
public COSObject dereference()(Code)
return the real object. this is needed for polymorphic handling of document elements. at application programming level only COSObject, never COSReference is seen. de.intarsys.pdf.cos.COSObject

getContainer
public ICOSContainer getContainer()(Code)
Answer the object that contains this. The container is never null. Answer the object that contains this.

getDoc
public COSDocument getDoc()(Code)
The document that contains this.
This may return null, as COSObject graphs may be created "offline" and add to the document as a whole.

The document is evaluated via the COSObject graph hierarchy that finally must be contained within a document.
The document that contains this.

getIndirectObject
public COSIndirectObject getIndirectObject()(Code)
return the indirect object for the receiver. application level programmers should not use this method. this is needed for creating a physical representation of the document (serializing) the indirect object for the receiver

hasNavigationPathTo
protected boolean hasNavigationPathTo(COSObject other)(Code)
Answer true if the receiver has a navigation path to other.
Parameters:
  other - The object we search a path to from this. Answer true if the receiver has a navigation pathto other.

isDangling
public boolean isDangling()(Code)
true if this object is not contained in a document directly or indirectly. This is especially true when an object is new (or reset to this state when an undo happend). Remember that an object can still be garbage, even if it is not dangling. true if this object is not contained in a documentdirectly or indirectly.

isIndirect
public boolean isIndirect()(Code)
Answer true if this object is an indirect one. true if this object is an indirect one.

isNull
public boolean isNull()(Code)
answer true if receiver is the null object true if receiver is the null object

isNumber
public boolean isNumber()(Code)
answer true if receiver is a number answer true if receiver is a number

isObjectListenerAvailable
abstract public boolean isObjectListenerAvailable()(Code)
true if an ICOSObjectListener is registered. This is for test purposes.

isPrimitive
abstract public boolean isPrimitive()(Code)
Answer true if this object is of a primitive type Answer true if this object is of a primitive type

isSwapped
public boolean isSwapped()(Code)

iterator
abstract public Iterator iterator()(Code)
An iterator over contained objects. The iterator is an empty iterator if this is not a container.
This iterator returns only COSObject instances, references are dereferenced.
Iterator over contained objects.

removeContainer
protected ICOSContainer removeContainer(ICOSContainer oldContainer)(Code)

removeObjectListener
abstract public void removeObjectListener(ICOSObjectListener listener)(Code)
Remove a listener for object changes.
Parameters:
  listener - The listener to be removed.

restoreState
public void restoreState(Object saveState)(Code)

stringValue
public String stringValue()(Code)
A string representation for the receiver. A string representation for the receiver.

toString
public String toString()(Code)

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

Methods inherited from de.intarsys.pdf.cos.COSDocumentElement
abstract public Object accept(ICOSObjectVisitor visitor) throws COSVisitorException(Code)(Java Doc)
abstract protected ICOSContainer addContainer(ICOSContainer newContainer)(Code)(Java Doc)
abstract public COSDocumentElement containable()(Code)(Java Doc)
abstract protected COSObject copyDeep(Map copied)(Code)(Java Doc)
abstract protected COSDocumentElement copyShallowNested()(Code)(Java Doc)
abstract public COSObject dereference()(Code)(Java Doc)
protected boolean equals(Object o, Set visited)(Code)(Java Doc)
abstract public COSDocument getDoc()(Code)(Java Doc)
public void handleException(COSRuntimeException ex) throws COSRuntimeException(Code)(Java Doc)
public boolean isReference()(Code)(Java Doc)
public boolean isSwapped()(Code)(Java Doc)
abstract protected void registerWith(COSDocument doc)(Code)(Java Doc)
abstract protected ICOSContainer removeContainer(ICOSContainer oldContainer)(Code)(Java Doc)

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.