org.pdfclown.documents.contents.xObjects.ImageXObject Class Reference

Image external object [PDF:1.6:4.8.4]. More...

Inheritance diagram for org.pdfclown.documents.contents.xObjects.ImageXObject:

List of all members.

Public Member Functions
virtual object	Clone (Document context)
	Gets a clone of the object, registered inside the given document context.
virtual bool	Delete ()
	Removes the object from its document context.
override bool	Equals (object obj)
override int	GetHashCode ()
	ImageXObject (Document context, PdfStream baseDataObject)
Static Public Member Functions
static PdfDirectObject	GetBaseObject (PdfObjectWrapper wrapper)
	Gets the PDF object backing the specified wrapper.
static new ImageXObject	Wrap (PdfDirectObject baseObject)
	Wraps an external object reference into an external object.
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]
int	BitsPerComponent [get]
	Gets the number of bits per color component.
string	ColorSpace [get]
	Gets the color space in which samples are specified.
PdfIndirectObject	Container [get]
	Gets the indirect object containing the base object.
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.
LayerEntity	Layer [get, set]
	Gets/Sets the layer associated to this object.
override Matrix	Matrix [get, set]
	Gets/Sets the mapping from external-object space to user space.
override SizeF	Size [get, set]
	Gets the size of the image (in samples).

---

Image external object [PDF:1.6:4.8.4].

---

Constructor & Destructor Documentation

org.pdfclown.documents.contents.xObjects.ImageXObject.ImageXObject	(	Document	context,
		PdfStream	baseDataObject
	)

References org.pdfclown.objects.PdfStream.Header.

---

Member Function Documentation

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

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.

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

wrapper

)

[static, inherited]

Gets the PDF object backing the specified wrapper.

Parameters:

wrapper

Object to extract the base from.

override int org.pdfclown.objects.PdfObjectWrapper.GetHashCode

(

)

[inherited]

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 new ImageXObject org.pdfclown.documents.contents.xObjects.ImageXObject.Wrap

(

PdfDirectObject

baseObject

)

[static]

Wraps an external object reference into an external object.

Parameters:

baseObject

External object base object.

Returns:

External object associated to the reference.

Reimplemented from org.pdfclown.documents.contents.xObjects.XObject.

---

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.

int org.pdfclown.documents.contents.xObjects.ImageXObject.BitsPerComponent [get]

Gets the number of bits per color component.

string org.pdfclown.documents.contents.xObjects.ImageXObject.ColorSpace [get]

Gets the color space in which samples are specified.

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

Gets the indirect object containing the base object.

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.

LayerEntity org.pdfclown.documents.contents.xObjects.XObject.Layer [get, set, inherited]

Gets/Sets the layer associated to this object.

Implements org.pdfclown.documents.contents.layers.ILayerable.

override Matrix org.pdfclown.documents.contents.xObjects.ImageXObject.Matrix [get, set]

Gets/Sets the mapping from external-object space to user space.

Reimplemented from org.pdfclown.documents.contents.xObjects.XObject.

override SizeF org.pdfclown.documents.contents.xObjects.ImageXObject.Size [get, set]

Gets the size of the image (in samples).

Reimplemented from org.pdfclown.documents.contents.xObjects.XObject.