org.pdfclown.documents.files.FileSpecification Class Reference

Reference to the contents of another file (file specification) [PDF:1.6:3.10.2]. More...

Inheritance diagram for org.pdfclown.documents.files.FileSpecification:

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)
string	GetAbsolutePath ()
	Gets the file absolute path.
override int	GetHashCode ()
virtual bytes::IInputStream	GetInputStream ()
	Gets an input stream to read from the file.
virtual bytes::IOutputStream	GetOutputStream ()
	Gets an output stream to write into the file.
Static Public Member Functions
static FullFileSpecification	Get (Document context, Uri url)
	Creates a new reference to a remote file.
static FullFileSpecification	Get (EmbeddedFile embeddedFile, string filename)
	Creates a new reference to an embedded file.
static FileSpecification	Get (Document context, string path, bool full)
	Creates a new reference to a file.
static SimpleFileSpecification	Get (Document context, string path)
	Creates a new reference to an external file.
static PdfDirectObject	GetBaseObject (PdfObjectWrapper wrapper)
	Gets the PDF object backing the specified wrapper.
static FileSpecification	Wrap (PdfDirectObject baseObject)
	Instantiates an existing file reference.
Protected Member Functions
void	CheckCompatibility (object feature)
	Checks whether the specified feature is compatible with the document's conformance version.
	FileSpecification (PdfDirectObject baseObject)
	FileSpecification (Document context, PdfDirectObject baseDataObject)
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
PdfDirectObject	BaseObject [get]
	Gets the underlying reference object, if available; otherwise, gets the underlying data object.
virtual PdfDirectObject	BaseObject [get, set]
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.
PdfString	Name [get]
	Gets the object name.
PdfDirectObject	NamedBaseObject [get]
	Gets the object name, if available; otherwise, behaves like BaseObject.
abstract string	Path [get]
	Gets the file path.

---

Reference to the contents of another file (file specification) [PDF:1.6:3.10.2].

---

Constructor & Destructor Documentation

org.pdfclown.documents.files.FileSpecification.FileSpecification	(	Document	context,
		PdfDirectObject	baseDataObject
	)			[protected]

org.pdfclown.documents.files.FileSpecification.FileSpecification

(

PdfDirectObject

baseObject

)

[protected]

---

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 FullFileSpecification org.pdfclown.documents.files.FileSpecification.Get	(	Document	context,
		Uri	url
	)			[static]

Creates a new reference to a remote file.

Parameters:

	context	Document context.
	url	Remote file location.

static FullFileSpecification org.pdfclown.documents.files.FileSpecification.Get	(	EmbeddedFile	embeddedFile,
		string	filename
	)			[static]

Creates a new reference to an embedded file.

Parameters:

	embeddedFile	Embedded file corresponding to the reference.
	filename	Name corresponding to the reference.

static FileSpecification org.pdfclown.documents.files.FileSpecification.Get	(	Document	context,
		string	path,
		bool	full
	)			[static]

Creates a new reference to a file.

Parameters:

	context	Document context.
	path	File path.
	full	Whether the reference is able to support extended dependencies.

static SimpleFileSpecification org.pdfclown.documents.files.FileSpecification.Get	(	Document	context,
		string	path
	)			[static]

Creates a new reference to an external file.

Parameters:

	context	Document context.
	path	File path.

References org.pdfclown.documents.files.FileSpecification.Get().

Referenced by org.pdfclown.documents.files.FileSpecification.Get().

string org.pdfclown.documents.files.FileSpecification.GetAbsolutePath

(

)

Gets the file absolute path.

static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject

(

PdfObjectWrapper< PdfDirectObject >

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 bytes::IInputStream org.pdfclown.documents.files.FileSpecification.GetInputStream

(

)

[virtual]

Gets an input stream to read from the file.

Reimplemented in org.pdfclown.documents.files.FullFileSpecification.

Referenced by org.pdfclown.objects.PdfStream.GetBody().

virtual bytes::IOutputStream org.pdfclown.documents.files.FileSpecification.GetOutputStream

(

)

[virtual]

Gets an output stream to write into the file.

Reimplemented in org.pdfclown.documents.files.FullFileSpecification.

Referenced by org.pdfclown.objects.PdfStream.WriteTo().

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 FileSpecification org.pdfclown.documents.files.FileSpecification.Wrap

(

PdfDirectObject

baseObject

)

[static]

Instantiates an existing file reference.

Parameters:

baseObject

Base object.

References org.pdfclown.objects.PdfObject.Resolve().

---

Property Documentation

PdfDirectObject org.pdfclown.objects.IPdfObjectWrapper.BaseObject [get, inherited]

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

Implemented in org.pdfclown.objects.PdfObjectWrapper.

Referenced by org.pdfclown.documents.interaction.actions.SetLayerState.LayerStates.Add(), and org.pdfclown.documents.interaction.actions.SetLayerState.LayerStates.Insert().

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.

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.

PdfString org.pdfclown.documents.files.FileSpecification.Name [get]

Gets the object name.

As names are tipically loosely-coupled with their corresponding PDF objects, name retrieval implies a costly reverse lookup into the document's name tree.

Implements org.pdfclown.objects.IPdfNamedObjectWrapper.

PdfDirectObject org.pdfclown.documents.files.FileSpecification.NamedBaseObject [get]

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

Implements org.pdfclown.objects.IPdfNamedObjectWrapper.

abstract string org.pdfclown.documents.files.FileSpecification.Path [get]

Gets the file path.

Reimplemented in org.pdfclown.documents.files.FullFileSpecification, and org.pdfclown.documents.files.SimpleFileSpecification.

Referenced by org.pdfclown.objects.PdfStream.WriteTo().