Class RenditionAction
-
- All Implemented Interfaces:
public class RenditionAction extends AbstractMediaAction
A rendition action controls the playing of multimedia content.
Note: JavaScript actions are not supported.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
RenditionAction.RenditionActionType
Types of rendition actions.
-
Field Summary
Fields Modifier and Type Field Description public final RenditionAction.RenditionActionType
renditionActionType
public final String
javascript
-
Method Summary
Modifier and Type Method Description RenditionAction.RenditionActionType
getRenditionActionType()
Type of rendition action to be performed on the specified screen annotation (if any). String
getJavascript()
Returns a text string containing a JavaScript script to be executed when the action is triggered. int
getScreenAnnotationObjectNumber()
Returns the object number of the referenced screen annotation (if any). Maybe<ScreenAnnotation>
getScreenAnnotationAsync(@NonNull() PdfDocument pdfDocument)
Returns screen annotation associated with this rendition action, asynchronously. ActionType
getType()
Returns type of action to make down-casting easier. boolean
equals(Object o)
int
hashCode()
String
toString()
-
-
Method Detail
-
getRenditionActionType
@NonNull() RenditionAction.RenditionActionType getRenditionActionType()
Type of rendition action to be performed on the specified screen annotation (if any).
- Returns:
Rendition action type.
-
getJavascript
@Nullable() 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.
-
getScreenAnnotationObjectNumber
int getScreenAnnotationObjectNumber()
Returns the object number of the referenced screen annotation (if any).
- Returns:
referenced annotation object number.
-
getScreenAnnotationAsync
@NonNull() Maybe<ScreenAnnotation> getScreenAnnotationAsync(@NonNull() 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 Maybe that either emits the requested annotation in `onSuccess()` or terminates with `onCompleted()` or `onError()`.
-
getType
@NonNull() ActionType getType()
Returns type of action to make down-casting easier.
- Returns:
Type of this action.
-
hashCode
int hashCode()
-
-
-
-