public class

Movie

extends Annot
java.lang.Object
   ↳ com.pdftron.pdf.Annot
     ↳ com.pdftron.pdf.annots.Movie

Class Overview

The Class Movie.

Summary

[Expand]
Inherited Constants
From class com.pdftron.pdf.Annot
Public Constructors
Movie(Annot annot)
Creates a Movie annotation and initialize it using given annotation object.
Public Methods
static Movie create(Doc doc, Rect pos)
Creates a new Movie annotation, in the specified document.
String getTitle()
Get the title of the Movie Annotation.
boolean isToBePlayed()
Get the option of whether the Movie is to be played.
void setTitle(String title)
Set the title of the Movie Annotation.
void setToBePlayed(boolean isplay)
Set the option of whether the Movie is to be played.
[Expand]
Inherited Methods
From class com.pdftron.pdf.Annot
From class java.lang.Object

Public Constructors

public Movie (Annot annot)

Creates a Movie annotation and initialize it using given annotation object.

Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Parameters
annot the annot

Public Methods

public static Movie create (Doc doc, Rect pos)

Creates a new Movie annotation, in the specified document.

Parameters
doc A document to which the Movie annotation is added.
pos A rectangle specifying the Movie annotation's bounds, specified in user space coordinates.
Returns
  • A newly created blank Movie annotation.

public String getTitle ()

Get the title of the Movie Annotation.

Note: Movie actions may use this title to reference the movie annotation.

Returns
  • A string representing the title of the Movie Annotation

public boolean isToBePlayed ()

Get the option of whether the Movie is to be played.

Note: IsToBePlayed is a flag specifying whether to play the movie when the annotation is activated. The movie shall be played using default activation parameters. If the value is false, the movie shall not be played. Default value: true.

Returns
  • a boolean value indicating if the movie is to be played

public void setTitle (String title)

Set the title of the Movie Annotation. (Optional)

Note: Movie actions may use this title to reference the movie annotation.

Parameters
title A string representing the title of the Movie Annotation

public void setToBePlayed (boolean isplay)

Set the option of whether the Movie is to be played. (Optional)

Note: IsToBePlayed is a flag specifying whether to play the movie when the annotation is activated. The movie shall be played using default activation parameters. If the value is false, the movie shall not be played. Default value: true.

Parameters
isplay A boolean value telling if the movie is to be played. Default value: true.