Package com.itextpdf.text.pdf.richmedia

Class RichMediaActivation

java.lang.Object

com.itextpdf.text.pdf.PdfObject

com.itextpdf.text.pdf.PdfDictionary

com.itextpdf.text.pdf.richmedia.RichMediaActivation

All Implemented Interfaces:

Serializable

public class RichMediaActivation
extends PdfDictionary

The RichMediaActivation dictionary specifies the style of presentation, default script behavior, default view information, and animation style when the annotation is activated. See ExtensionLevel 3 p78

Since:

5.0.0

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.itextpdf.text.pdf.PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class com.itextpdf.text.pdf.PdfObject

ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor	Description
RichMediaActivation()	Creates a RichMediaActivation dictionary.

Method Summary

Modifier and Type	Method	Description
void	setAnimation(RichMediaAnimation animation)	Sets the animation dictionary describing the preferred method that conforming readers should use to drive keyframe animations present in this artwork.
void	setCondition(PdfName condition)	Sets the activation condition.
void	setConfiguration(PdfIndirectReference configuration)	Sets an indirect object reference to a RichMediaConfiguration dictionary that shall also be referenced by the Configurations array in the RichMediaContent dictionary (which is part of the RichMediaAnnotation object).
void	setPresentation(RichMediaPresentation richMediaPresentation)	Sets a RichMediaPresentation dictionary that contains information as to how the annotation and user interface elements will be visually laid out and drawn.
void	setScripts(PdfArray scripts)	Sets an array of indirect object references to file specification dictionaries, each of which describe a JavaScript file that shall be present in the Assets name tree of the RichMediaContent dictionary.
void	setView(PdfIndirectReference view)	Sets an indirect object reference to a 3D view dictionary that shall also be referenced by the Views array within the annotation's RichMediaContent dictionary.

Methods inherited from class com.itextpdf.text.pdf.PdfDictionary

checkType, clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString

Methods inherited from class com.itextpdf.text.pdf.PdfObject

canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

RichMediaActivation

public RichMediaActivation()

Creates a RichMediaActivation dictionary.

Method Details

setCondition

public void setCondition(PdfName condition)

Sets the activation condition. Set it to XA if the annotation is explicitly activated by a user action or script (this is the default). To PO, if the annotation is activated as soon as the page that contains the annotation receives focus as the current page. To PV, if the annotation is activated as soon as any part of the page that contains the annotation becomes visible. One example is in a multiple-page presentation. Only one page is the current page although several are visible.

Parameters:

condition - possible values are: PdfName.XA, PdfName.PO, or PdfName.PV

setAnimation

public void setAnimation(RichMediaAnimation animation)

Sets the animation dictionary describing the preferred method that conforming readers should use to drive keyframe animations present in this artwork.

Parameters:

animation - a RichMediaAnimation dictionary

setView

public void setView(PdfIndirectReference view)

Sets an indirect object reference to a 3D view dictionary that shall also be referenced by the Views array within the annotation's RichMediaContent dictionary.

Parameters:

view - an indirect reference

setConfiguration

public void setConfiguration(PdfIndirectReference configuration)

Sets an indirect object reference to a RichMediaConfiguration dictionary that shall also be referenced by the Configurations array in the RichMediaContent dictionary (which is part of the RichMediaAnnotation object).

Parameters:

configuration - an indirect reference

setPresentation

public void setPresentation(RichMediaPresentation richMediaPresentation)

Sets a RichMediaPresentation dictionary that contains information as to how the annotation and user interface elements will be visually laid out and drawn.

Parameters:

richMediaPresentation - a RichMediaPresentation object

setScripts

public void setScripts(PdfArray scripts)

Sets an array of indirect object references to file specification dictionaries, each of which describe a JavaScript file that shall be present in the Assets name tree of the RichMediaContent dictionary.

Parameters:

scripts - a PdfArray