Class RichMediaConfiguration

java.lang.Object

com.itextpdf.text.pdf.PdfObject

com.itextpdf.text.pdf.PdfDictionary

com.itextpdf.text.pdf.richmedia.RichMediaConfiguration

All Implemented Interfaces:

Serializable

public class RichMediaConfiguration
extends PdfDictionary

The RichMediaConfiguration dictionary describes a set of instances that are loaded for a given scene configuration. The configuration to be loaded when an annotation is activated is referenced by the Configuration key in the RichMediaActivation dictionary specified in the RichMediaSettings dictionary. see ExtensionLevel 3 p88

Since:

5.0.0

See Also:

• RichMediaAnnotation
• RichMediaInstance
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PdfArray	instances	An array of indirect object references to RichMediaInstance dictionaries.

Fields inherited from class PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class PdfObject

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

Constructor Summary

Constructors

Constructor	Description
RichMediaConfiguration(PdfName subtype)	Creates a RichMediaConfiguration object.

Method Summary

Modifier and Type	Method	Description
void	addInstance(RichMediaInstance instance)	Adds a RichMediaInstance to the instances array of this configuration.
void	setName(PdfString name)	Sets the name of the configuration (must be unique).

Methods inherited from class 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 PdfObject

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

Methods inherited from class Object

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

Field Details

instances

protected PdfArray instances

An array of indirect object references to RichMediaInstance dictionaries.

Constructor Details

RichMediaConfiguration

public RichMediaConfiguration(PdfName subtype)

Creates a RichMediaConfiguration object. Also specifies the primary content type for the configuration. Valid values are 3D, Flash, Sound, and Video.

Parameters:

subtype - Possible values are: PdfName._3D, PdfName.FLASH, PdfName.SOUND, and PdfName.VIDEO.

Method Details

setName

public void setName(PdfString name)

Sets the name of the configuration (must be unique).

Parameters:

name - the name

addInstance

public void addInstance(RichMediaInstance instance)

Adds a RichMediaInstance to the instances array of this configuration.

Parameters:

instance - a RichMediaInstance