Package com.itextpdf.text.pdf.richmedia
Class RichMediaPresentation
java.lang.Object
com.itextpdf.text.pdf.PdfObject
com.itextpdf.text.pdf.PdfDictionary
com.itextpdf.text.pdf.richmedia.RichMediaPresentation
- All Implemented Interfaces:
Serializable
The RichMediaPresentation dictionary contains information about how the
annotation and user interface elements are to be visually laid out and
drawn.
See ExtensionLevel 3 p82
- Since:
- 5.0.0
- See Also:
-
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
setNavigationPane
(PdfBoolean navigationPane) Sets a flag that indicates the default behavior of the navigation pane user interface element.void
setPassContextClick
(PdfBoolean passContextClick) Sets a flag that indicates whether a context click on the rich media annotation is passed to the media player run time or is handled by the conforming reader.void
Sets the style for the presentation; can be embedded or windowed.void
setToolbar
(PdfBoolean toolbar) Sets a flag that indicates the default behavior of an interactive toolbar associated with this annotation.void
setTransparent
(PdfBoolean transparent) Set a flag that indicates whether the page content is displayed through the transparent areas of the rich media content (where the alpha value is less than 1.0).void
setWindow
(RichMediaWindow window) A RichMediaWindow Dictionary that describes the size and position of the floating user interface window when the value for Style is set to Windowed.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
-
RichMediaPresentation
public RichMediaPresentation()Creates a RichMediaPresentation dictionary.
-
-
Method Details
-
setStyle
Sets the style for the presentation; can be embedded or windowed.- Parameters:
style
- PdfName.EMBEDDED or PdfName.WINDOWED
-
setWindow
A RichMediaWindow Dictionary that describes the size and position of the floating user interface window when the value for Style is set to Windowed.- Parameters:
window
- a RichMediaWindow object
-
setTransparent
Set a flag that indicates whether the page content is displayed through the transparent areas of the rich media content (where the alpha value is less than 1.0). If true, the rich media artwork is composited over the page content using an alpha channel. If false, the rich media artwork is drawn over an opaque background prior to composition over the page content.- Parameters:
transparent
- a boolean
-
setToolbar
Sets a flag that indicates the default behavior of an interactive toolbar associated with this annotation. If true, a toolbar is displayed when the annotation is activated and given focus. If false, a toolbar is not displayed by default.- Parameters:
toolbar
- a boolean
-
setPassContextClick
Sets a flag that indicates whether a context click on the rich media annotation is passed to the media player run time or is handled by the conforming reader. If false, the conforming reader handles the context click. If true, the conforming reader's context menu is not visible, and the user sees the context menu and any custom items generated by the media player run time.- Parameters:
passContextClick
- a boolean
-