org.pdfclown.documents.interaction.actions.Render Class Reference

'Control the playing of multimedia content' action [PDF:1.6:8.5.3]. More...

Inheritance diagram for org.pdfclown.documents.interaction.actions.Render:

List of all members.

Public Types
enum	OperationEnum {   Play, Stop, Pause, Resume,   PlayResume }
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 ()
	Render (Screen screen, OperationEnum operation, Rendition rendition)
	Creates a new action within the given document context.
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.
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.
Document	Document [get]
	Gets the document context.
File	File [get]
	Gets the file context.
OperationEnum	Operation [get, set]
	Gets/Sets the operation to perform when the action is triggered.
Rendition	Rendition [get, set]
	Gets/Sets the rendition object to render.
Screen	Screen [get, set]
	Gets/Sets the screen where to render the rendition object.
String	Script [get, set]
	Gets/Sets the JavaScript script to be executed when the action is triggered.

---

'Control the playing of multimedia content' action [PDF:1.6:8.5.3].

---

Member Enumeration Documentation

enum org::pdfclown::documents::interaction::actions::Render::OperationEnum

Enumerator:

Play	Play the rendition on the screen, stopping any previous one.
Stop	Stop any rendition being played on the screen.
Pause	Pause any rendition being played on the screen.
Resume	Resume any rendition being played on the screen.
PlayResume	Play the rendition on the screen, resuming any previous one.

---

Constructor & Destructor Documentation

org.pdfclown.documents.interaction.actions.Render.Render	(	Screen	screen,
		OperationEnum	operation,
		Rendition	rendition
	)

Creates a new action within the given document context.

---

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.

Document org.pdfclown.objects.PdfObjectWrapper.Document [get, inherited]

Gets the document context.

File org.pdfclown.objects.PdfObjectWrapper.File [get, inherited]

Gets the file context.

OperationEnum org.pdfclown.documents.interaction.actions.Render.Operation [get, set]

Gets/Sets the operation to perform when the action is triggered.

Rendition org.pdfclown.documents.interaction.actions.Render.Rendition [get, set]

Gets/Sets the rendition object to render.

Screen org.pdfclown.documents.interaction.actions.Render.Screen [get, set]

Gets/Sets the screen where to render the rendition object.

String org.pdfclown.documents.interaction.actions.Render.Script [get, set]

Gets/Sets the JavaScript script to be executed when the action is triggered.

Referenced by org.pdfclown.documents.interaction.annotations.Screen.Screen().