MovieAnnotation

Inheritance: java.lang.Object, com.aspose.pdf.BaseParagraph, com.aspose.pdf.Annotation

All Implemented Interfaces: com.aspose.pdf.engine.ITitledAnnotation

public final class MovieAnnotation extends Annotation implements ITitledAnnotation

Represents a movie annotation that 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.

Constructors

ConstructorDescription
MovieAnnotation(IDocument document, String movieFile)Constructor for using with Generator.
MovieAnnotation(Page page, Rectangle rect, String movieFile)Creates new Sound annotation on the specified page.

Methods

MethodDescription
getTitle()Gets the title of the movie annotation.
setTitle(String value)Sets the title of the movie annotation.
getFile()Gets a file specification identifying a self-describing movie file.
setFile(FileSpecification value)Sets a file specification identifying a self-describing movie file.
getPoster()Gets or sets a flag or stream specifying whether and how a poster image representing the movie shall be displayed.
setPoster(boolean value)Gets or sets a flag or stream specifying whether and how a poster image representing the movie shall be displayed.
getAspect()Gets or sets the width and height of the movie\ufffds bounding box, in pixels.
setAspect(Point value)Gets or sets the width and height of the movie\ufffds bounding box, in pixels.
getRotate()Gets or sets the number of degrees by which the movie shall be rotated clockwise relative to the page.
setRotate(int value)Gets or sets the number of degrees by which the movie shall be rotated clockwise relative to the page.
getAnnotationType()Gets type of annotation.
accept(AnnotationSelector visitor)Accepts visitor object to process the annotation.

MovieAnnotation(IDocument document, String movieFile)

public MovieAnnotation(IDocument document, String movieFile)

Constructor for using with Generator.

Parameters:

ParameterTypeDescription
documentIDocumentDocument where movie annotation will be created.
movieFilejava.lang.StringName of movie file.

MovieAnnotation(Page page, Rectangle rect, String movieFile)

public MovieAnnotation(Page page, Rectangle rect, String movieFile)

Creates new Sound annotation on the specified page.

Parameters:

ParameterTypeDescription
pagePageThe document’s page where annotation should be created.
rectRectangleThe annotation rectangle, defining the location of the annotation on the page.
movieFilejava.lang.StringA movie file to be played when the annotation is activated.

getTitle()

public String getTitle()

Gets the title of the movie annotation.

Returns: java.lang.String - String value

setTitle(String value)

public void setTitle(String value)

Sets the title of the movie annotation.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

getFile()

public FileSpecification getFile()

Gets a file specification identifying a self-describing movie file.

Returns: FileSpecification - FileSpecification value

setFile(FileSpecification value)

public void setFile(FileSpecification value)

Sets a file specification identifying a self-describing movie file.

Parameters:

ParameterTypeDescription
valueFileSpecificationFileSpecification object

getPoster()

public final boolean getPoster()

Gets or sets a flag or stream specifying whether and how a poster image representing the movie shall be displayed. If true, the poster image shall be retrieved from the movie file; if it is false, no poster shall be displayed.

Returns: boolean - boolean value

setPoster(boolean value)

public final void setPoster(boolean value)

Gets or sets a flag or stream specifying whether and how a poster image representing the movie shall be displayed. If true, the poster image shall be retrieved from the movie file; if it is false, no poster shall be displayed.

Parameters:

ParameterTypeDescription
valuebooleanboolean value

getAspect()

public final Point getAspect()

Gets or sets the width and height of the movie\ufffds bounding box, in pixels.

Returns: Point - Point instance

setAspect(Point value)

public final void setAspect(Point value)

Gets or sets the width and height of the movie\ufffds bounding box, in pixels.

Parameters:

ParameterTypeDescription
valuePointPoint instance

getRotate()

public final int getRotate()

Gets or sets the number of degrees by which the movie shall be rotated clockwise relative to the page. The value shall be a multiple of 90.

Returns: int - int value

setRotate(int value)

public final void setRotate(int value)

Gets or sets the number of degrees by which the movie shall be rotated clockwise relative to the page. The value shall be a multiple of 90.

Parameters:

ParameterTypeDescription
valueintint value

getAnnotationType()

public AnnotationType getAnnotationType()

Gets type of annotation.

Returns: AnnotationType - AnnotationType element as int value

accept(AnnotationSelector visitor)

public void accept(AnnotationSelector visitor)

Accepts visitor object to process the annotation.

Parameters:

ParameterTypeDescription
visitorAnnotationSelectorVisitor object.