org.pdfclown.objects.Array< TItem > Class Template Reference

Collection of sequentially-arranged object wrappers. More...

Inheritance diagram for org.pdfclown.objects.Array< TItem >:

Classes
class	DefaultWrapper< T >
interface	IWrapper< T >
	Item instancer. More...
Public Member Functions
virtual void	Add (TItem item)
	Array (Document context, IWrapper< TItem > itemWrapper, PdfArray baseDataObject)
	Wraps the specified base array using the specified wrapper for wrapping its items.
	Array (Document context, PdfArray baseDataObject)
	Wraps the specified base array using the default wrapper for wrapping its items.
	Array (Document context, IWrapper< TItem > itemWrapper)
	Wraps a new base array using the specified wrapper for wrapping its items.
	Array (Document context)
	Wraps a new base array using the default wrapper for wrapping its items.
virtual void	Clear ()
virtual object	Clone (Document context)
	Gets a clone of the object, registered inside the given document context.
virtual bool	Contains (TItem item)
virtual void	CopyTo (TItem[] items, int index)
virtual bool	Delete ()
	Removes the object from its document context.
override bool	Equals (object obj)
virtual IEnumerator< TItem >	GetEnumerator ()
override int	GetHashCode ()
virtual int	IndexOf (TItem item)
virtual void	Insert (int index, TItem item)
virtual bool	Remove (TItem item)
virtual void	RemoveAt (int index)
Static Public Member Functions
static PdfDirectObject	GetBaseObject (PdfObjectWrapper wrapper)
	Gets the PDF object backing the specified wrapper.
static Array< T >	Wrap< T > (Array< T >.IWrapper< T > itemWrapper, PdfDirectObject baseObject)
	Wraps an existing base array using the specified wrapper for wrapping its items.
static Array< T >	Wrap< T > (PdfDirectObject baseObject)
	Wraps an existing base array using the default wrapper for wrapping its items.
Protected Member Functions
	Array (IWrapper< TItem > itemWrapper, PdfDirectObject baseObject)
	Wraps an existing base array using the specified wrapper for wrapping its items.
	Array (PdfDirectObject baseObject)
	Wraps an existing base array using the default wrapper for wrapping its items.
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.
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 TItem	this [int index] `[get, set]`

template<TItem>
class org::pdfclown::objects::Array< TItem >

Collection of sequentially-arranged object wrappers.

Type Constraints

TItem

:

IPdfObjectWrapper

Constructor & Destructor Documentation

template<TItem >

org.pdfclown.objects.Array< TItem >.Array ( Document context )

Wraps a new base array using the default wrapper for wrapping its items.

Parameters:

context

Document context.

template<TItem >

org.pdfclown.objects.Array< TItem >.Array	(	Document	context,
		IWrapper< TItem >	itemWrapper
	)

Wraps a new base array using the specified wrapper for wrapping its items.

Parameters:

	context	Document context.
	itemWrapper	Item wrapper.

template<TItem >

org.pdfclown.objects.Array< TItem >.Array	(	Document	context,
		PdfArray< TItem >	baseDataObject
	)

Wraps the specified base array using the default wrapper for wrapping its items.

Parameters:

	context	Document context.
	baseDataObject	Base array.

template<TItem >

org.pdfclown.objects.Array< TItem >.Array	(	Document	context,
		IWrapper< TItem >	itemWrapper,
		PdfArray< TItem >	baseDataObject
	)

Wraps the specified base array using the specified wrapper for wrapping its items.

Parameters:

	context	Document context.
	itemWrapper	Item wrapper.
	baseDataObject	Base array.

template<TItem >

org.pdfclown.objects.Array< TItem >.Array ( PdfDirectObject baseObject ) [protected]

Wraps an existing base array using the default wrapper for wrapping its items.

Parameters:

baseObject

Base array. MUST be a reference everytime available.

template<TItem >

org.pdfclown.objects.Array< TItem >.Array	(	IWrapper< TItem >	itemWrapper,
		PdfDirectObject	baseObject
	)			`[protected]`

Wraps an existing base array using the specified wrapper for wrapping its items.

Parameters:

	itemWrapper	Item wrapper.
	baseObject	Base array. MUST be a reference everytime available.

Member Function Documentation

template<TItem >

virtual void org.pdfclown.objects.Array< TItem >.Add ( TItem item ) [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<TItem >

virtual void org.pdfclown.objects.Array< TItem >.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<TItem >

virtual bool org.pdfclown.objects.Array< TItem >.Contains ( TItem item ) [virtual]

template<TItem >

virtual void org.pdfclown.objects.Array< TItem >.CopyTo	(	TItem[]	items,
		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).

override bool org.pdfclown.objects.PdfObjectWrapper.Equals ( object obj ) [inherited]

static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject ( PdfObjectWrapper< PdfArray > wrapper ) [static, inherited]

Gets the PDF object backing the specified wrapper.

Parameters:

wrapper

Object to extract the base from.

template<TItem >

virtual IEnumerator<TItem> org.pdfclown.objects.Array< TItem >.GetEnumerator ( ) [virtual]

override int org.pdfclown.objects.PdfObjectWrapper.GetHashCode ( ) [inherited]

template<TItem >

virtual int org.pdfclown.objects.Array< TItem >.IndexOf ( TItem item ) [virtual]

template<TItem >

virtual void org.pdfclown.objects.Array< TItem >.Insert	(	int	index,
		TItem	item
	)			`[virtual]`

template<TItem >

virtual bool org.pdfclown.objects.Array< TItem >.Remove ( TItem item ) [virtual]

template<TItem >

virtual void org.pdfclown.objects.Array< TItem >.RemoveAt ( int index ) [virtual]

Reimplemented in org.pdfclown.documents.PageElements< TItem >.

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.

PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.RetrieveNamedBaseObject ( ) [protected, inherited]

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

template<TItem >

static Array<T> org.pdfclown.objects.Array< TItem >.Wrap< T >	(	Array< T >.IWrapper< T >	itemWrapper,
		PdfDirectObject	baseObject
	)			`[static]`

Wraps an existing base array using the specified wrapper for wrapping its items.

Parameters:

	itemWrapper	Item wrapper.
	baseObject	Base array. MUST be a reference every time available.

Type Constraints

T

:

TItem

template<TItem >

static Array<T> org.pdfclown.objects.Array< TItem >.Wrap< T > ( PdfDirectObject baseObject ) [static]

Wraps an existing base array using the default wrapper for wrapping its items.

Parameters:

	itemClass	Item class.
	baseObject	Base array. MUST be a reference every time available.

Type Constraints

T

:

TItem

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<TItem >

virtual int org.pdfclown.objects.Array< TItem >.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<TItem >

virtual bool org.pdfclown.objects.Array< TItem >.IsReadOnly [get]

template<TItem >

virtual TItem org.pdfclown.objects.Array< TItem >.this[int index] [get, set]

org.pdfclown.objects.Array< TItem > Class Template Reference

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

template<TItem> class org::pdfclown::objects::Array< TItem >

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation

template<TItem>
class org::pdfclown::objects::Array< TItem >