org.pdfclown.objects.Tree< TKey, TValue > Class Template Reference

Abstract tree [PDF:1.7:3.8.5]. More...

Inheritance diagram for org.pdfclown.objects.Tree< TKey, TValue >:

List of all members.

Classes
class	Children
class	Enumerator
interface	IFiller< TObject >
class	KeysFiller
class	ValuesFiller
Public Member Functions
virtual void	Add (TKey key, TValue value)
virtual void	Clear ()
virtual object	Clone (Document context)
	Gets a clone of the object, registered inside the given document context.
virtual bool	ContainsKey (TKey key)
virtual void	CopyTo (KeyValuePair< TKey, TValue >[] keyValuePairs, int index)
virtual bool	Delete ()
	Removes the object from its document context.
override bool	Equals (object obj)
virtual IEnumerator < KeyValuePair< TKey, TValue > >	GetEnumerator ()
override int	GetHashCode ()
TKey	GetKey (TValue value)
virtual bool	Remove (KeyValuePair< TKey, TValue > keyValuePair)
virtual bool	Remove (TKey key)
virtual bool	TryGetValue (TKey key, out TValue value)
Static Public Member Functions
static PdfDirectObject	GetBaseObject (PdfObjectWrapper wrapper)
	Gets the PDF object backing the specified wrapper.
Protected Member Functions
void	CheckCompatibility (object feature)
	Checks whether the specified feature is compatible with the document's conformance version.
virtual PdfString	RetrieveName ()
	Retrieves the name possibly associated to this object, walking through the document's name dictionary.
PdfDirectObject	RetrieveNamedBaseObject ()
	Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.
	Tree (PdfDirectObject baseObject)
	Tree (Document context)
abstract TValue	WrapValue (PdfDirectObject baseObject)
	Wraps a base object within its corresponding high-level representation.
Properties
virtual PdfDirectObject	BaseObject [get, set]
PdfIndirectObject	Container [get]
	Gets the indirect object containing the base object.
virtual int	Count [get]
PdfIndirectObject	DataContainer [get]
	Gets the indirect object containing the base data object.
Document	Document [get]
	Gets the document context.
File	File [get]
	Gets the file context.
virtual bool	IsReadOnly [get]
virtual ICollection< TKey >	Keys [get]
abstract PdfName	PairsKey [get]
	Gets the name of the key-value pairs entries.
virtual TValue	this [TKey key] [get, set]
virtual ICollection< TValue >	Values [get]

---

template<TKey, TValue>
class org::pdfclown::objects::Tree< TKey, TValue >

Abstract tree [PDF:1.7:3.8.5].

Type Constraints

TKey	:	PdfDirectObject
TKey	:	IPdfSimpleObject
TValue	:	PdfObjectWrapper

---

Constructor & Destructor Documentation

template<TKey , TValue >

org.pdfclown.objects.Tree< TKey, TValue >.Tree

(

Document

context

)

[protected]

template<TKey , TValue >

org.pdfclown.objects.Tree< TKey, TValue >.Tree

(

PdfDirectObject

baseObject

)

[protected]

---

Member Function Documentation

template<TKey , TValue >

virtual void org.pdfclown.objects.Tree< TKey, TValue >.Add	(	TKey	key,
		TValue	value
	)			[virtual]

void org.pdfclown.objects.PdfObjectWrapper.CheckCompatibility

(

object

feature

)

[protected, inherited]

Checks whether the specified feature is compatible with the document's conformance version.

Parameters:

feature

Entity whose compatibility has to be checked. Supported types: VersionEnum Property name resolvable to an annotated getter method MemberInfo

template<TKey , TValue >

virtual void org.pdfclown.objects.Tree< TKey, TValue >.Clear

(

)

[virtual]

virtual object org.pdfclown.objects.PdfObjectWrapper.Clone

(

Document

context

)

[virtual, inherited]

Gets a clone of the object, registered inside the given document context.

Parameters:

context

Which document the clone has to be registered in.

template<TKey , TValue >

virtual bool org.pdfclown.objects.Tree< TKey, TValue >.ContainsKey

(

TKey

key

)

[virtual]

template<TKey , TValue >

virtual void org.pdfclown.objects.Tree< TKey, TValue >.CopyTo	(	KeyValuePair< TKey, TValue >[]	keyValuePairs,
		int	index
	)			[virtual]

virtual bool org.pdfclown.objects.PdfObjectWrapper.Delete

(

)

[virtual, inherited]

Removes the object from its document context.

The object is no more usable after this method returns.

Returns:

Whether the object was actually decontextualized (only indirect objects can be decontextualize).

Reimplemented in org.pdfclown.documents.interaction.annotations.Annotation, org.pdfclown.documents.interaction.navigation.page.Article, and org.pdfclown.documents.interaction.navigation.page.ArticleElement.

override bool org.pdfclown.objects.PdfObjectWrapper.Equals

(

object

obj

)

[inherited]

Reimplemented in org.pdfclown.documents.contents.fonts.Font.

static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject

(

PdfObjectWrapper< PdfDictionary >

wrapper

)

[static, inherited]

Gets the PDF object backing the specified wrapper.

Parameters:

wrapper

Object to extract the base from.

template<TKey , TValue >

virtual IEnumerator<KeyValuePair<TKey,TValue> > org.pdfclown.objects.Tree< TKey, TValue >.GetEnumerator

(

)

[virtual]

override int org.pdfclown.objects.PdfObjectWrapper.GetHashCode

(

)

[inherited]

Reimplemented in org.pdfclown.documents.contents.fonts.Font.

template<TKey , TValue >

TKey org.pdfclown.objects.Tree< TKey, TValue >.GetKey

(

TValue

value

)

Gets the key associated to the specified value.

template<TKey , TValue >

virtual bool org.pdfclown.objects.Tree< TKey, TValue >.Remove

(

KeyValuePair< TKey, TValue >

keyValuePair

)

[virtual]

template<TKey , TValue >

virtual bool org.pdfclown.objects.Tree< TKey, TValue >.Remove

(

TKey

key

)

[virtual]

References org.pdfclown.objects.PdfArray.Count, org.pdfclown.objects.PdfReference.DataObject, org.pdfclown.objects.PdfReference.Delete(), org.pdfclown.objects.PdfArray.IndexOf(), org.pdfclown.objects.PdfArray.Parent, org.pdfclown.objects.PdfReference.Parent, org.pdfclown.objects.PdfReference.Reference, org.pdfclown.objects.PdfObject.Reference, and org.pdfclown.objects.PdfObject.Resolve().

virtual PdfString org.pdfclown.objects.PdfObjectWrapper.RetrieveName

(

)

[protected, virtual, inherited]

Retrieves the name possibly associated to this object, walking through the document's name dictionary.

Reimplemented in org.pdfclown.documents.multimedia.Rendition.

PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.RetrieveNamedBaseObject

(

)

[protected, inherited]

Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.

template<TKey , TValue >

virtual bool org.pdfclown.objects.Tree< TKey, TValue >.TryGetValue	(	TKey	key,
		out TValue	value
	)			[virtual]

template<TKey , TValue >

abstract TValue org.pdfclown.objects.Tree< TKey, TValue >.WrapValue

(

PdfDirectObject

baseObject

)

[protected, pure virtual]

Wraps a base object within its corresponding high-level representation.

---

Property Documentation

virtual PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.BaseObject [get, set, inherited]

Gets the underlying reference object, if available; otherwise, gets the underlying data object.

PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.Container [get, inherited]

Gets the indirect object containing the base object.

template<TKey , TValue >

virtual int org.pdfclown.objects.Tree< TKey, TValue >.Count [get]

PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.DataContainer [get, inherited]

Gets the indirect object containing the base data object.

Document org.pdfclown.objects.PdfObjectWrapper.Document [get, inherited]

Gets the document context.

File org.pdfclown.objects.PdfObjectWrapper.File [get, inherited]

Gets the file context.

template<TKey , TValue >

virtual bool org.pdfclown.objects.Tree< TKey, TValue >.IsReadOnly [get]

template<TKey , TValue >

virtual ICollection<TKey> org.pdfclown.objects.Tree< TKey, TValue >.Keys [get]

template<TKey , TValue >

abstract PdfName org.pdfclown.objects.Tree< TKey, TValue >.PairsKey [get, protected]

Gets the name of the key-value pairs entries.

template<TKey , TValue >

virtual TValue org.pdfclown.objects.Tree< TKey, TValue >.this[TKey key] [get, set]

template<TKey , TValue >

virtual ICollection<TValue> org.pdfclown.objects.Tree< TKey, TValue >.Values [get]