Package com.itextpdf.text.pdf.richmedia
Class RichMediaParams
java.lang.Object
com.itextpdf.text.pdf.PdfObject
com.itextpdf.text.pdf.PdfDictionary
com.itextpdf.text.pdf.richmedia.RichMediaParams
- All Implemented Interfaces:
Serializable
Dictionary containing parameters related to an active Flash subtype
in a RichMediaInstance dictionary.
See ExtensionLevel 3 p90
- Since:
- 5.0.0
- See Also:
-
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
setBinding
(PdfName binding) Sets the binding.void
setBindingMaterialName
(PdfString bindingMaterialName) Stores the material name that content is to be bound to.void
setCuePoints
(PdfArray cuePoints) Sets an array of CuePoint dictionaries containing points in time within a Flash animation.void
setFlashVars
(String flashVars) Sets a text string containing formatted name value pairs passed to the Flash Player context when activated.void
setSettings
(PdfString settings) A text string used to store settings information associated with a Flash RichMediaInstance.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
-
Constructor Details
-
RichMediaParams
public RichMediaParams()Creates a RichMediaParams object.
-
-
Method Details
-
setFlashVars
Sets a text string containing formatted name value pairs passed to the Flash Player context when activated.- Parameters:
flashVars
- a String with the Flash variables
-
setBinding
Sets the binding.- Parameters:
binding
- possible values: PdfName.NONE, PdfName.FOREGROUND, PdfName.BACKGROUND, PdfName.MATERIAL
-
setBindingMaterialName
Stores the material name that content is to be bound to. Required if Binding value is Material.- Parameters:
bindingMaterialName
- a material name
-
setCuePoints
Sets an array of CuePoint dictionaries containing points in time within a Flash animation.- Parameters:
cuePoints
- a PdfArray with CuePoint objects
-
setSettings
A text string used to store settings information associated with a Flash RichMediaInstance. It is to be stored and loaded by the scripting run time.- Parameters:
settings
- a PdfString
-