Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.faceless.pdf2
Class AnnotationRichMedia

    java.lang.Object
      org.faceless.pdf2.PDFAnnotation
          org.faceless.pdf2.AnnotationRichMedia

All Implemented Interfaces:
  Cloneable

    public class AnnotationRichMedia

extends PDFAnnotation

This class is a type of `PDFAnnotation` that acts as a container for interactive media such as Flash and (eventually) video.

For example, to embed a Flash animation in a page:

     EmbeddedFile file = new EmbeddedFile(new File("myfile.swf"));
     AnnotationRichMedia annot = new AnnotationRichMedia();
     annot.setEmbeddedFile(file, "Flash", "PO", "PC");
     annot.setPage(page);
     annot.setRectangle(100, 600, 300, 800);

Since:
  2.11.14

Constructor Summary
`AnnotationRichMedia()` Creates a new rich media annotation.

Method Summary
`void` | `setEmbeddedFile(EmbeddedFile file, String type, String activationCondition, String deactivationCondition)` Sets the embedded rich media file to use within this annotation.
`String` | `toString()`

Methods inherited from class org.faceless.pdf2.PDFAnnotation
`addPropertyChangeListener, addReview, flatten, getAuthor, getColor, getContents, getCreationDate, getInReplyTo, getMetaData, getModifyDate, getOpacity, getPage, getPopup, getRectangle, getReplies, getReviews, getSubject, getType, getUniqueID, hasAppearanceState, isContentLocked, isPositionLocked, isPrintable, isReadOnly, isVisible, removePropertyChangeListener, setAuthor, setColor, setContents, setCreationDate, setInReplyTo, setLocked, setMetaData, setModifyDate, setOpacity, setPage, setPrintable, setReadOnly, setRectangle, setSubject, setUniqueID, setVisible`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### AnnotationRichMedia

    public AnnotationRichMedia()

  Creates a new rich media annotation.

Method Detail

### setEmbeddedFile

    public void setEmbeddedFile(EmbeddedFile file,
                                String type,
                                String activationCondition,
                                String deactivationCondition)

  Sets the embedded rich media file to use within this annotation.

  Parameters:
    `file` - the embedded file
    `type` - the primary content type of the file. Currently the only valid value is "Flash"
    `activationCondition` - the condition under which the media will be activated. Valid values are "XA" (script or user activation), "PO" (activated when page receives focus), and "PV" (activated when page becomes visible)
    `deactivationCondition` - the condition under which the media will be deactivated. Valid values are "XD" (script or user deactivation), "PC" (deactivated when page loses focus), and "PI" (deactivated when no part of the page is any longer visible).

### toString

    public String toString()

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2012 Big Faceless Organization