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

public class RichMediaInstance
extends PdfDictionary

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:

RichMediaConfiguration, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	flash True if the instance is a flash animation.

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 and Description
RichMediaInstance(PdfName subtype) Creates a RichMediaInstance.

Method Summary

Modifier and Type	Method and Description
void	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

Methods inherited from class java.lang.Object

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

Field Detail

flash

protected boolean flash

True if the instance is a flash animation.

Constructor Detail

RichMediaInstance

public RichMediaInstance(PdfName subtype)

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 Detail

setParams

public void setParams(RichMediaParams params)

Sets the parameters. This will only work for Flash.

Parameters:

params - a RichMediaParams object

setAsset

public void 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.

Parameters:

asset - a reference to a dictionary present in the Assets name tree