Package com.itextpdf.text.pdf.richmedia
Class RichMediaInstance
java.lang.Object
com.itextpdf.text.pdf.PdfObject
com.itextpdf.text.pdf.PdfDictionary
com.itextpdf.text.pdf.richmedia.RichMediaInstance
- All Implemented Interfaces:
Serializable
The RichMediaInstance dictionary, referenced by the Instances entry
of the RichMediaConfiguration, describes a single instance of an asset
with settings to populate the artwork of an annotation.
See ExtensionLevel 3 p88
- Since:
- 5.0.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
True if the instance is a flash animation. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
setAsset
(PdfIndirectReference asset) Sets a dictionary that shall be an indirect object reference to a file specification dictionary that is also referenced in the Assets name tree of the content of the annotation.void
setParams
(RichMediaParams params) Sets the parameters.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
-
Field Details
-
flash
protected boolean flashTrue if the instance is a flash animation.
-
-
Constructor Details
-
RichMediaInstance
Creates a RichMediaInstance. Also specifies the content type for the instance. Valid values are 3D, Flash, Sound, and Video. The subtype must match the asset file type of the instance.- Parameters:
subtype
- possible values are: PdfName._3D, PdfName.FLASH, PdfName.SOUND, and PdfName.VIDEO.
-
-
Method Details
-
setParams
Sets the parameters. This will only work for Flash.- Parameters:
params
- a RichMediaParams object
-
setAsset
Sets a dictionary that shall be an indirect object reference to a file specification dictionary that is also referenced in the Assets name tree of the content of the annotation.- Parameters:
asset
- a reference to a dictionary present in the Assets name tree
-