|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.itextpdf.text.pdf.richmedia.RichMediaAnnotation
public class RichMediaAnnotation
Object that is able to create Rich Media Annotations as described in the document "Acrobat Supplement to the ISO 32000", referenced in the code as "ExtensionLevel 3". This annotation is described in section 9.6 entitled "Rich Media" of this document. Extension level 3 introduces rich media PDF constructs that support playing a SWF file and provide enhanced rich media. With rich media annotation, Flash applications, video, audio, and other multimedia can be attached to a PDF with expanded functionality. It improves upon the existing 3D annotation structure to support multiple multimedia file assets, including Flash video and compatible variations on the H.264 format. The new constructs allow a two-way scripting bridge between Flash and a conforming application. There is support for generalized linking of a Flash application state to a comment or view, which enables video commenting. Finally, actions can be linked to video chapter points.
Field Summary | |
---|---|
protected com.itextpdf.text.pdf.PdfAnnotation |
annot
The annotation object |
protected HashMap<String,com.itextpdf.text.pdf.PdfIndirectReference> |
assetsmap
a map with the assets (will be used to construct a name tree.) |
protected com.itextpdf.text.pdf.PdfArray |
configurations
an array with configurations (will be added to the RichMediaContent). |
protected com.itextpdf.text.pdf.PdfDictionary |
richMediaContent
the rich media content (can be reused for different annotations) |
protected com.itextpdf.text.pdf.PdfIndirectReference |
richMediaContentReference
a reference to the RichMediaContent that can be reused. |
protected com.itextpdf.text.pdf.PdfDictionary |
richMediaSettings
the rich media settings (specific for this annotation) |
protected com.itextpdf.text.pdf.PdfArray |
views
an array of views (will be added to the RichMediaContent) |
protected com.itextpdf.text.pdf.PdfWriter |
writer
The PdfWriter to which the annotation will be added. |
Constructor Summary | |
---|---|
RichMediaAnnotation(com.itextpdf.text.pdf.PdfWriter writer,
com.itextpdf.text.Rectangle rect)
Creates a RichMediaAnnotation. |
|
RichMediaAnnotation(com.itextpdf.text.pdf.PdfWriter writer,
com.itextpdf.text.Rectangle rect,
com.itextpdf.text.pdf.PdfIndirectReference richMediaContentReference)
Creates a RichMediaAnnotation using rich media content that has already been added to the writer. |
Method Summary | |
---|---|
com.itextpdf.text.pdf.PdfIndirectReference |
addAsset(String name,
com.itextpdf.text.pdf.PdfFileSpecification fs)
Adds an embedded file. |
com.itextpdf.text.pdf.PdfIndirectReference |
addAsset(String name,
com.itextpdf.text.pdf.PdfIndirectReference ref)
Adds a reference to an embedded file. |
com.itextpdf.text.pdf.PdfIndirectReference |
addConfiguration(com.itextpdf.text.pdf.PdfIndirectReference ref)
Adds a reference to a RichMediaConfiguration. |
com.itextpdf.text.pdf.PdfIndirectReference |
addConfiguration(RichMediaConfiguration configuration)
Adds a RichMediaConfiguration. |
com.itextpdf.text.pdf.PdfIndirectReference |
addView(com.itextpdf.text.pdf.PdfDictionary view)
Adds a view dictionary. |
com.itextpdf.text.pdf.PdfIndirectReference |
addView(com.itextpdf.text.pdf.PdfIndirectReference ref)
Adds a reference to a view dictionary. |
com.itextpdf.text.pdf.PdfAnnotation |
createAnnotation()
Creates the actual annotation and adds different elements to the PdfWriter while doing so. |
com.itextpdf.text.pdf.PdfIndirectReference |
getRichMediaContentReference()
Gets a reference to the RichMediaContent for reuse of the rich media content. |
void |
setActivation(RichMediaActivation richMediaActivation)
Sets the RichMediaActivation dictionary specifying the style of presentation, default script behavior, default view information, and animation style when the annotation is activated. |
void |
setDeactivation(RichMediaDeactivation richMediaDeactivation)
Sets the RichMediaDeactivation dictionary specifying the condition that causes deactivation of the annotation. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected com.itextpdf.text.pdf.PdfWriter writer
protected com.itextpdf.text.pdf.PdfAnnotation annot
protected com.itextpdf.text.pdf.PdfDictionary richMediaContent
protected com.itextpdf.text.pdf.PdfIndirectReference richMediaContentReference
protected com.itextpdf.text.pdf.PdfDictionary richMediaSettings
protected HashMap<String,com.itextpdf.text.pdf.PdfIndirectReference> assetsmap
protected com.itextpdf.text.pdf.PdfArray configurations
protected com.itextpdf.text.pdf.PdfArray views
Constructor Detail |
---|
public RichMediaAnnotation(com.itextpdf.text.pdf.PdfWriter writer, com.itextpdf.text.Rectangle rect)
writer
- the PdfWriter to which the annotation will be added.rect
- the rectangle where the annotation will be added.public RichMediaAnnotation(com.itextpdf.text.pdf.PdfWriter writer, com.itextpdf.text.Rectangle rect, com.itextpdf.text.pdf.PdfIndirectReference richMediaContentReference)
writer
- the PdfWriter to which the annotation will be added.rect
- the rectangle where the annotation will be added.richMediaContentReference
- reused rich media content.Method Detail |
---|
public com.itextpdf.text.pdf.PdfIndirectReference getRichMediaContentReference()
public com.itextpdf.text.pdf.PdfIndirectReference addAsset(String name, com.itextpdf.text.pdf.PdfFileSpecification fs) throws IOException
name
- a name for the name treefs
- a file specification for an embedded file.
IOException
public com.itextpdf.text.pdf.PdfIndirectReference addAsset(String name, com.itextpdf.text.pdf.PdfIndirectReference ref) throws IOException
ref
- a reference to a PdfFileSpecification
IOException
public com.itextpdf.text.pdf.PdfIndirectReference addConfiguration(RichMediaConfiguration configuration) throws IOException
configuration
- a configuration dictionary
IOException
public com.itextpdf.text.pdf.PdfIndirectReference addConfiguration(com.itextpdf.text.pdf.PdfIndirectReference ref) throws IOException
ref
- a reference to a RichMediaConfiguration
IOException
public com.itextpdf.text.pdf.PdfIndirectReference addView(com.itextpdf.text.pdf.PdfDictionary view) throws IOException
view
- a view dictionary
IOException
public com.itextpdf.text.pdf.PdfIndirectReference addView(com.itextpdf.text.pdf.PdfIndirectReference ref) throws IOException
ref
- a reference to a view dictionary
IOException
public void setActivation(RichMediaActivation richMediaActivation)
richMediaActivation
- public void setDeactivation(RichMediaDeactivation richMediaDeactivation)
richMediaDeactivation
- public com.itextpdf.text.pdf.PdfAnnotation createAnnotation() throws IOException
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |