ScreenAnnotation
Contents
[
Hide
]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
| Constructor | Description |
|---|---|
| ScreenAnnotation(Page page, Rectangle rect, String mediaFile) | Creates new Screen annotation on the specified page. |
Methods
| Method | Description |
|---|---|
| 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:
| Parameter | Type | Description |
|---|---|---|
| page | Page | The document’s page where annotation should be created. |
| rect | Rectangle | The annotation rectangle, defining the location of the annotation on the page. |
| mediaFile | java.lang.String | The path to multimedia file. |
accept(AnnotationSelector visitor)
public void accept(AnnotationSelector visitor)
Represent accept method
Parameters:
| Parameter | Type | Description |
|---|---|---|
| visitor | AnnotationSelector | AnnotationSelector 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:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | String 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:
| Parameter | Type | Description |
|---|---|---|
| value | PdfAction | PdfAction object |
getAnnotationType()
public AnnotationType getAnnotationType()
Gets type of annotation.
Returns: AnnotationType - AnnotationType element
