org.pdfclown.documents.interaction.actions.GotoNonLocal< T > Class Template Reference

Abstract 'go to non-local destination' action. More...

Inheritance diagram for org.pdfclown.documents.interaction.actions.GotoNonLocal< T >:

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 ()
Static Public Member Functions
static PdfDirectObject	GetBaseObject (PdfObjectWrapper wrapper)
	Gets the PDF object backing the specified wrapper.
static Action	Wrap (PdfDirectObject baseObject)
	Wraps an action base object into an action object.
Protected Member Functions
void	CheckCompatibility (object feature)
	Checks whether the specified feature is compatible with the document's conformance version.
	GotoNonLocal (PdfDirectObject baseObject)
	GotoNonLocal (Document context, PdfName actionType, FileSpecification destinationFile, T destination)
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
ChainedActions	Actions [get, set]
	Gets/Sets the actions to be performed after the current one.
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.
T	Destination [get, set]
	Gets/Sets the destination to jump to.
virtual FileSpecification	DestinationFile [get, set]
	Gets/Sets the file in which the destination is located.
Document	Document [get]
	Gets the document context.
File	File [get]
	Gets the file context.
OptionsEnum	Options [get, set]
	Gets/Sets the action options.

---

template<T>
class org::pdfclown::documents::interaction::actions::GotoNonLocal< T >

Abstract 'go to non-local destination' action.

Type Constraints

T

:

Destination

---

Constructor & Destructor Documentation

template<T >

org.pdfclown.documents.interaction.actions.GotoNonLocal< T >.GotoNonLocal	(	Document	context,
		PdfName	actionType,
		FileSpecification	destinationFile,
		T	destination
	)			[protected]

template<T >

org.pdfclown.documents.interaction.actions.GotoNonLocal< T >.GotoNonLocal

(

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).

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.

override int org.pdfclown.objects.PdfObjectWrapper.GetHashCode

(

)

[inherited]

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

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.

static Action org.pdfclown.documents.interaction.actions.Action.Wrap

(

PdfDirectObject

baseObject

)

[static, inherited]

Wraps an action base object into an action object.

Parameters:

baseObject

Action base object.

Returns:

Action object associated to the base object.

References org.pdfclown.objects.PdfDictionary.ContainsKey(), org.pdfclown.objects.PdfDictionary.Equals(), and org.pdfclown.objects.PdfObject.Resolve().

---

Property Documentation

ChainedActions org.pdfclown.documents.interaction.actions.Action.Actions [get, set, inherited]

Gets/Sets the actions to be performed after the current one.

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.

template<T >

T org.pdfclown.documents.interaction.actions.GoToDestination< T >.Destination [get, set, inherited]

Gets/Sets the destination to jump to.

template<T >

virtual FileSpecification org.pdfclown.documents.interaction.actions.GotoNonLocal< T >.DestinationFile [get, set]

Gets/Sets the file in which the destination is located.

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

OptionsEnum org.pdfclown.documents.interaction.actions.GotoNonLocal< T >.Options [get, set]

Gets/Sets the action options.