org.pdfclown.documents.contents.Contents Class Reference

Content stream [PDF:1.6:3.7.1]. More...

Inheritance diagram for org.pdfclown.documents.contents.Contents:

List of all members.

Classes
class	ContentStream
	Content stream wrapper.
Public Member Functions
void	Add (ContentObject obj)
void	Clear ()
virtual object	Clone (Document context)
	Gets a clone of the object, registered inside the given document context.
override object	Clone (Document context)
bool	Contains (ContentObject obj)
void	CopyTo (ContentObject[] objs, int index)
virtual bool	Delete ()
	Removes the object from its document context.
override bool	Equals (object obj)
void	Flush ()
	Serializes the contents into the content stream.
IEnumerator< ContentObject >	GetEnumerator ()
override int	GetHashCode ()
int	IndexOf (ContentObject obj)
void	Insert (int index, ContentObject obj)
bool	Remove (ContentObject obj)
void	RemoveAt (int index)
Static Public Member Functions
static PdfDirectObject	GetBaseObject (PdfObjectWrapper wrapper)
	Gets the PDF object backing the specified wrapper.
static Contents	Wrap (PdfDirectObject baseObject, IContentContext contentContext)
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.
Properties
virtual PdfDirectObject	BaseObject [get, set]
PdfIndirectObject	Container [get]
	Gets the indirect object containing the base object.
IContentContext	ContentContext [get]
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.
bool	IsReadOnly [get]
ContentObject	this [int index] [get, set]

---

Content stream [PDF:1.6:3.7.1].

During its loading, this content stream is parsed and its instructions are exposed as a list; in case of modifications, it's user responsability to call the Flush() method in order to serialize back the instructions into this content stream.

---

Member Function Documentation

void org.pdfclown.documents.contents.Contents.Add

(

ContentObject

obj

)

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

void org.pdfclown.documents.contents.Contents.Clear

(

)

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.

override object org.pdfclown.documents.contents.Contents.Clone

(

Document

context

)

bool org.pdfclown.documents.contents.Contents.Contains

(

ContentObject

obj

)

void org.pdfclown.documents.contents.Contents.CopyTo	(	ContentObject[]	objs,
		int	index
	)

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]

Reimplemented in org.pdfclown.documents.contents.colorSpaces.LeveledColor.

void org.pdfclown.documents.contents.Contents.Flush

(

)

Serializes the contents into the content stream.

References org.pdfclown.objects.PdfArray.Add(), org.pdfclown.objects.PdfStream.Body, org.pdfclown.objects.PdfArray.Count, org.pdfclown.objects.PdfArray.Resolve(), org.pdfclown.bytes.IBuffer.SetLength(), and org.pdfclown.documents.contents.objects.ContentObject.WriteTo().

static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject

(

PdfObjectWrapper< PdfDataObject >

wrapper

)

[static, inherited]

Gets the PDF object backing the specified wrapper.

Parameters:

wrapper

Object to extract the base from.

IEnumerator<ContentObject> org.pdfclown.documents.contents.Contents.GetEnumerator

(

)

override int org.pdfclown.objects.PdfObjectWrapper.GetHashCode

(

)

[inherited]

Reimplemented in org.pdfclown.documents.contents.colorSpaces.LeveledColor.

int org.pdfclown.documents.contents.Contents.IndexOf

(

ContentObject

obj

)

void org.pdfclown.documents.contents.Contents.Insert	(	int	index,
		ContentObject	obj
	)

bool org.pdfclown.documents.contents.Contents.Remove

(

ContentObject

obj

)

void org.pdfclown.documents.contents.Contents.RemoveAt

(

int

index

)

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.

static Contents org.pdfclown.documents.contents.Contents.Wrap	(	PdfDirectObject	baseObject,
		IContentContext	contentContext
	)			[static]

---

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.

IContentContext org.pdfclown.documents.contents.Contents.ContentContext [get]

Referenced by org.pdfclown.tools.Renderer.Render().

int org.pdfclown.documents.contents.Contents.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.

bool org.pdfclown.documents.contents.Contents.IsReadOnly [get]

ContentObject org.pdfclown.documents.contents.Contents.this[int index] [get, set]