java.lang.Object
- Torello.Browser.Animation

```
public class Animation
extends java.lang.Object
```
Class created by Automatic Code-Generator.
This class was built using the Chrome Remote Dev-Tools A.P.I., which is specified by two JSON-RPC Files. These files were obtained from the Chrome Dev Tools Protocol Git Hub Page, which has a "Tip of Tree" (the latest) API-Specification Page Here: JSON-RPC Protocol Specification.

JSON-Viewable Google-API:
These files may be viewed here: browser_protocol.json and js_protocol.json.
These files were converted into this Java-Browser (CDT) Library; they are a Java-Alternative to the Node.js implementation.

HTML-Viewable API:
In addition to this Class-Library, these files were also converted to a simple HTML Page, which may be browsed here: Browser API Web-Page

Node.js RDP-API Implementation:
You may read about the Node.js Chrome Remote Interface on the Node.js Package Manager Web-Site: NPM
[No Description Provided by Google]
This class is intended to be used with a Headless Browser
These methods have been tested, to some degree, using Google Chrome. In order to use this class you must start a web-browser instance and make a connection to the browser using a Remote Debugging Port. The initializations may be accomplished using class BRDPC (Browser Remote Debug Protocol Connection).

Google-Chrome was used during the development process of the classes in this particular package. Note that, lately, it has been asserted Microsoft has switched to using the Chrome-Engine for its Microsoft Edge Browser Internal Code-Base. Therefore, there may limited support / functionality when running the methods in this class with Microsoft-Edge. There is the possibility these will work with Opera & Safari.

Check whether the your Web-Browser will allow itself to be driven by the Web-Socket RDP-Port 9223.

Foreign Function API:
Every one of the methods that reside in this class are designed to do nothing more than:
1. Accept Parameters from the User, and "Marshall Them" into a Valid JSON-Request
2. Transmit the Marshalled Request-JSON to a Headless Web-Browser over a Web-Socket RDP Connection
3. Receive BOTH that Method's Results AND any Browser Event-Firings from the Web-Socket
4. Parse JSON Method-Results and Browser-Event Firings, and Subsequently Convert them to Standard Java-Types
5. Report these Method-Results and Browser-Events to the User via an User-Registered Event-Listener or a Promise Object
Java-HTML Difference:
Unlike the bulk of the Java HTML JAR Library, there is very little native Java-Code, and very little testing that may be done on any of the classes & methods in this package. The code inside these classes does nothing more than marshall-and-unmarshall Java-Types into Json-Requests (and vice-versa). The Java-Script & Browser modules inside of a Google-Chrome instance are, theoretically, handling these requests, and returning their results (or events) over the Web-Socket Connection.

It has been asserted (by Google Chrome Developers) that some of these methods are only "partially working" or "experimental".
Hi-Lited Source-Code:
- View Here: Torello/Browser/Animation.java
- Open New Browser-Tab: Torello/Browser/Animation.java
File Size: 48,098 Bytes Line Count: 1,211 '\n' Characters Found
Stateless Class:
This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's @Stateless Annotation.
- 1 Constructor(s), 1 declared private, zero-argument constructor
- 10 Method(s), 10 declared static
- 5 Field(s), 5 declared static, 4 declared final
- Fields excused from final modifier (with explanation):
  
  Field 'counter' is not final. Reason: CONFIGURATION

Nested Class Summary

Type Classes: Animation Domain Types

Modifier and Type	Inner-Class
`static class`	`Animation.AnimationEffect`	AnimationEffect instance
`static class`	`Animation.KeyframesRule`	Keyframes Rule
`static class`	`Animation.KeyframeStyle`	Keyframe Style

Event Classes: Animation Domain Events
Modifier and Type	Inner-Class
`static class`	`Animation._Animation`	Animation instance.
`static class`	`Animation.animationCanceled`	Event for when an animation has been cancelled.
`static class`	`Animation.animationCreated`	Event for each animation that has been created.
`static class`	`Animation.animationStarted`	Event for animation that has been started.

Method Summary

Animation Domain Commands

Script Returns	Modifier and Type	Method
NONE (`void`)	`static Script<>`	`disable()` Disables animation domain notifications.
NONE (`void`)	`static Script<>`	`enable()` Enables animation domain notifications.
`Number`	`static Script<>`	`getCurrentTime(String id)` Returns the current time of the an animation.
`Number`	`static Script<>`	`getPlaybackRate()` Gets the playback rate of the document timeline.
NONE (`void`)	`static Script<>`	`releaseAnimations(String[] animations)` Releases a set of animations to no longer be manipulated.
`RunTime.RemoteObject`	`static Script<>`	`resolveAnimation(String animationId)` Gets the remote object of the Animation.
NONE (`void`)	`static Script<>`	`seekAnimations(String[] animations, Number currentTime)` Seek a set of animations to a particular time within each animation.
NONE (`void`)	`static Script<>`	`setPaused(String[] animations, boolean paused)` Sets the paused state of a set of animations.
NONE (`void`)	`static Script<>`	`setPlaybackRate(Number playbackRate)` Sets the playback rate of the document timeline.
NONE (`void`)	`static Script<>`	`setTiming(String animationId, Number duration, Number delay)` Sets the timing of an animation node.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - disable
    
    🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> disable()
    
    Disables animation domain notifications.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - enable
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> enable()
    
    Enables animation domain notifications.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - getCurrentTime
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,java.lang.Number> getCurrentTime (java.lang.String id)
    
    Returns the current time of the an animation.
    
    Parameters:
    
    id - Id of animation.
    
    Returns:
    
    An instance of Script<String, JsonObject, Number>
    
    This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, Number> will be returned.
    
    Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.
    
    This Browser Function returns
    
    Number (currentTime)
    Current time of the page.
  - getPlaybackRate
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,java.lang.Number> getPlaybackRate ()
    
    Gets the playback rate of the document timeline.
    
    Returns:
    
    An instance of Script<String, JsonObject, Number>
    
    This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, Number> will be returned.
    
    Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.
    
    This Browser Function returns
    
    Number (playbackRate)
    Playback rate for animations on page.
  - releaseAnimations
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> releaseAnimations (java.lang.String[] animations)
    
    Releases a set of animations to no longer be manipulated.
    
    Parameters:
    
    animations - List of animation ids to seek.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - resolveAnimation
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,RunTime.RemoteObject> resolveAnimation (java.lang.String animationId)
    
    Gets the remote object of the Animation.
    
    Parameters:
    
    animationId - Animation id.
    
    Returns:
    
    An instance of Script<String, JsonObject, RunTime.RemoteObject>
    
    This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, RunTime.RemoteObject> will be returned.
    
    Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.
    
    This Browser Function returns
    
    RunTime.RemoteObject (remoteObject)
    Corresponding remote object.
  - seekAnimations
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> seekAnimations (java.lang.String[] animations, java.lang.Number currentTime)
    
    Seek a set of animations to a particular time within each animation.
    
    Parameters:
    
    animations - List of animation ids to seek.
    
    currentTime - Set the current time of each animation.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - setPaused
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> setPaused (java.lang.String[] animations, boolean paused)
    
    Sets the paused state of a set of animations.
    
    Parameters:
    
    animations - Animations to set the pause state of.
    
    paused - Paused state to set to.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - setPlaybackRate
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> setPlaybackRate (java.lang.Number playbackRate)
    
    Sets the playback rate of the document timeline.
    
    Parameters:
    
    playbackRate - Playback rate for animations on page
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - setTiming
    
    🡅 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> setTiming (java.lang.String animationId, java.lang.Number duration, java.lang.Number delay)
    
    Sets the timing of an animation node.
    
    Parameters:
    
    animationId - Animation id.
    
    duration - Duration of the animation.
    
    delay - Delay of the animation.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

Methods
Script	disable()
Script	enable()
Script	getCurrentTime(String id)
Script	getPlaybackRate()
Script	releaseAnimations(String[] animations)
Script	resolveAnimation(String animationId)
Script	seekAnimations(String[] animations, Number currentTime)
Script	setPaused(String[] animations, boolean paused)
Script	setPlaybackRate(Number playbackRate)
Script	setTiming(String animationId, Number duration, Number delay)

Class Animation

This class is intended to be used with a Headless Browser

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

disable

enable

getCurrentTime

getPlaybackRate

releaseAnimations

resolveAnimation

seekAnimations

setPaused

setPlaybackRate

setTiming