ScreenAnnotation

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

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

public final class ScreenAnnotation extends Annotation implements ITitledAnnotation

A screen annotation that specifies a region of a page upon which media clips may be played.

Constructors

ConstructorDescription
ScreenAnnotation(Page page, Rectangle rect, String mediaFile)Creates new Screen annotation on the specified page.

Methods

MethodDescription
accept(AnnotationSelector visitor)Represent accept method
getTitle()Gets the title of the screen annotation.
setTitle(String value)Sets the title of the screen annotation.
getAction()Gets an action to be performed when the annotation is activated.
setAction(PdfAction value)Sets an action to be performed when the annotation is activated.
getAnnotationType()Gets type of annotation.

ScreenAnnotation(Page page, Rectangle rect, String mediaFile)

public ScreenAnnotation(Page page, Rectangle rect, String mediaFile)

Creates new Screen 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.
mediaFilejava.lang.StringThe path to multimedia file.

accept(AnnotationSelector visitor)

public void accept(AnnotationSelector visitor)

Represent accept method

Parameters:

ParameterTypeDescription
visitorAnnotationSelectorAnnotationSelector object

getTitle()

public String getTitle()

Gets the title of the screen annotation.

Returns: java.lang.String - String value

setTitle(String value)

public void setTitle(String value)

Sets the title of the screen annotation.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

getAction()

public PdfAction getAction()

Gets an action to be performed when the annotation is activated.

Returns: PdfAction - PdfAction object

setAction(PdfAction value)

public void setAction(PdfAction value)

Sets an action to be performed when the annotation is activated.

Parameters:

ParameterTypeDescription
valuePdfActionPdfAction object

getAnnotationType()

public AnnotationType getAnnotationType()

Gets type of annotation.

Returns: AnnotationType - AnnotationType element