Class PDFNet.MovieAnnot
PDFNet.MovieAnnot
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
A movie annotation contains animated graphics and sound to be
presented on the computer screen and through the speakers.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.MovieAnnot.create(doc, pos)
Creates a new Movie annotation in the specified document.
|
| <static> |
PDFNet.MovieAnnot.createFromAnnot(ann)
creates a Movie annotation and initializes it using given annotation object.
|
| <static> |
PDFNet.MovieAnnot.createFromObj(d)
creates a Movie annotation and initializes it using given Cos/SDF object.
|
|
getTitle()
Returns the title of the Movie Annotation.
|
|
|
Returns the option of whether the Movie is to be played.
|
|
|
setTitle(title)
sets the title of the Movie Annotation.
|
|
|
setToBePlayed(isplay)
sets the option of whether the Movie is to be played.
|
Class Detail
PDFNet.MovieAnnot(id)
A movie annotation contains animated graphics and sound to be
presented on the computer screen and through the speakers. When the
annotation is activated, the movie is played.
- Parameters:
- id
Method Detail
<static>
{MovieAnnot}
PDFNet.MovieAnnot.create(doc, pos)
Creates a new Movie annotation in the specified document.
- Parameters:
- {SDFDoc} doc
- A document to which the Movie annotation is added.
- {rect} pos
- A rectangle specifying the Movie annotation's bounds in default user space units.
- Returns:
- {MovieAnnot} A promise that resolves to a newly created blank Movie annotation.
<static>
{MovieAnnot}
PDFNet.MovieAnnot.createFromAnnot(ann)
creates a Movie annotation and initializes it using given annotation object.
- Parameters:
- {Annot} ann
- Annot object used to initialize the Movie annotation.
- Returns:
- {MovieAnnot} A promise that resolves to an object of type: "MovieAnnot" (generated documentation)
<static>
{MovieAnnot}
PDFNet.MovieAnnot.createFromObj(d)
creates a Movie annotation and initializes it using given Cos/SDF object.
- Parameters:
- {Obj} d
- The Cos/SDF object to initialze the annotation with.
- Returns:
- {MovieAnnot} A promise that resolves to an object of type: "MovieAnnot" (generated documentation)
{string}
getTitle()
Returns the title of the Movie Annotation.
- Returns:
- {string} A promise that resolves to a string representing the title of the Movie Annotation.
{boolean}
isToBePlayed()
Returns the option of whether the Movie is to be played.
- Returns:
- {boolean} A promise that resolves to a boolean value indicating if the movie is to be played.
setTitle(title)
sets the title of the Movie Annotation.
(Optional)
- Parameters:
- {string} title
- A string representing the title of the Movie Annotation.
setToBePlayed(isplay)
sets the option of whether the Movie is to be played.
(Optional)
- Parameters:
- {boolean} isplay
- A boolean value telling if the movie is to be played. Default value: true.