| java.lang.Object | |||
| ↳ | com.pspdfkit.annotations.actions.Action | ||
| ↳ | com.pspdfkit.annotations.actions.AbstractMediaAction | ||
| ↳ | com.pspdfkit.annotations.actions.RenditionAction | ||
Class Overview
A rendition action controls the playing of multimedia content.
Note: JavaScript actions are not supported.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| enum | RenditionAction.RenditionActionType | Types of rendition actions. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean | equals(Object o) | ||||||||||
| String |
getJavascript()
Returns a text string containing a JavaScript script to be executed when the action is
triggered.
| ||||||||||
| RenditionAction.RenditionActionType |
getRenditionActionType()
Type of rendition action to be performed on the specified screen annotation (if any).
| ||||||||||
| Maybe<ScreenAnnotation> |
getScreenAnnotationAsync(PdfDocument pdfDocument)
Returns screen annotation associated with this rendition action, asynchronously.
| ||||||||||
| int |
getScreenAnnotationObjectNumber()
Returns the object number of the referenced screen annotation (if any).
| ||||||||||
| ActionType |
getType()
Returns type of action to make down-casting easier.
| ||||||||||
| int | hashCode() | ||||||||||
| String | toString() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.pspdfkit.annotations.actions.AbstractMediaAction
| |||||||||||
|
From class
com.pspdfkit.annotations.actions.Action
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Methods
public String getJavascript ()
Returns a text string containing a JavaScript script to be executed when the action is triggered. If rendition action type is valid, and screen annotation is specified, the javascript will be executed first and rendition action will be used as a fallback in case of unsuccessful script execution.
Returns
- JavaScript script to be executed when the action is triggered.
public RenditionAction.RenditionActionType getRenditionActionType ()
Type of rendition action to be performed on the specified screen annotation (if any).
Returns
- Rendition action type.
public Maybe<ScreenAnnotation> getScreenAnnotationAsync (PdfDocument pdfDocument)
Returns screen annotation associated with this rendition action, asynchronously.
Parameters
| pdfDocument | PDF document in which to look for the associated screen annotation. |
|---|
Returns
- An instance of
Maybethat either emits the requested annotation in `onSuccess()` or terminates with `onCompleted()` or `onError()`.
public int getScreenAnnotationObjectNumber ()
Returns the object number of the referenced screen annotation (if any).
Returns
- referenced annotation object number.
public ActionType getType ()
Returns type of action to make down-casting easier.
Returns
- Type of this action.