Package Torello.Browser.BrowserAPI

Class Animation

java.lang.Object

Torello.Browser.BrowserAPI.Animation

public class Animation
extends java.lang.Object

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.

These files were converted into this Java-Browser (CDT) Library; they are a Java-Alternative to the Node.js implementation, other wise known as 'Puppeteer'. The Tool known as 'Selenium' also does quit a bit of Browser-Automation.

Viewable the Google-API:

• browser_protocol.json
• js_protocol.json
• Browser API HTML-Page
• Java-Script API HTML-Page

[No Description Provided by Google]

This class is intended to be used with a Browser Instance

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. Google-Corporation is the developer of this API, but any browser which accepts a Remote Debug Port Connection over Web-Sockets.

Google-Chrome was used during the development process of the classes in this particular package. Lately, it has been asserted Microsoft has switched to using the Chrome Browser-Engine for its Microsoft Edge Internal Code-Base. Therefore, there may some functionality available when running the methods in this class with Microsoft-Edge.

Check whether the your Web-Browser will allow itself to be driven by the Web-Socket RDP-Port 9223. See the examples available in package Torello.Browser to undertand how to build a PageConn and BrowserConn Web-Socket Connection, and how to build a WebSocketSender instance in order to execute the methods in this class.

Web-Socket & JSON 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 Connection
3. Receive BOTH that Command-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 a User-Registered, Event-Listener (Events) or a Promise Object (Command Responses / Results)

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".


Asking Chat-GPT for Help:
The LLM otherwise known as "Chat-GPT" does, indeed, have an expert level of knowledge about the "Remote DevTools Protocol". The API that the Chrome DevTools Protocl (CDP) exports is extremely well understood by the LLM, and generally I have found that Chat-GPT understands (by 2 or 3 orders of magnitude) better what my Auto-Generated JSON-Wrappers can do in controlling a Web-Browser than I could ever possibly hope to understand.

Though not available today, there will soon be an automatically downloadable Token-Stream (AI Embeddings) BUTTON available on my Java-Doc Pages that should hopefully make it extremely easy to post my code-base, RAG Style, to Chat-GPT and other LLM's when 'interogating' them. Presently, because my "Get Token Stream Button" does not exist yet on any of my pages, what you can do is copy-and-paste any Method-Signature from any one of these pages and then ask Chat-GPT to explain what that Browser or Java-Script Function is actually doing. It is very likely to give you some pretty neat answers.

I have found that every single one of the Domains, Types & Events which are offered by the CDP Protocol (though not documented very well by Google), are perfectly understood by the A.I. LLM - literally to the point where it does know (much better than I ever could) what my own code base actually does!

Try it out, it's a lot of fun. Note that this package and these classes were originally developed solely to be able to execute the Java-Script that a browser executes when visiting a Web-Site. Complete HTML-Page Content can be scraped (using the HTML Data-Scraping Tools in Java-HTML) off of Web-Sites that have dynamic / Java-Script Generated Content.


Conspicuous Boxed-Types Usage:
You may notice that there are many methods that have parameters which accept, for instance, an Integer, instead of a primitive int. Just to remind the readiner, in Java Programs a Boxed Type is a standard Java-Primitive which has been converted into an Object-Reference. The use of Boxed-Types in this code base is an easy-and-fast-way to allow for the concept of "Optional Parameters" or "Optional Field Value."

Whenever you see a method that accepts an Integer, the reason for this Parameter-Type choice is actually to allow a user to pass 'null' to it. This is a simple way to ELIDE passing any value at all to parameters which Google-Chrome would otherwise assert are "Optional." Whenever you pass 'null' to a Boxed-Types in this class, the Json-Processor will simply eliminate that Object-Property from the command altogether; and the browser will simply not receive any value for that parameter when that command is invoked.

The Java Language Specification does not have an easy or well defined means of accepting optional method parameters; so Boxed-Types and 'null' are utilized here. Note that 'null' may be passed to any Command Method-Parameter that is listed as Optional on the Java-Doc Page description for that parameter.

Hi-Lited Source-Code:

• View Here: Torello/Browser/BrowserAPI/Animation.java
• Open New Browser-Tab: Torello/Browser/BrowserAPI/Animation.java

File Size: 57,015 Bytes Line Count: 1,437 '\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	Class	Description
static class	Animation.AnimationEffect	AnimationEffect instance
static class	Animation.KeyframesRule	Keyframes Rule
static class	Animation.KeyframeStyle	Keyframe Style
static class	Animation.ViewOrScrollTimeline	Timeline instance
Event Classes: Animation Domain Events
Modifier and Type	Class	Description
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.
static class	Animation.animationUpdated	Event for animation that has been updated.

Method Summary

Animation Domain Commands
Modifier and Type	Method	Description
static Script<String, JsonObject, Ret0>	disable()	Disables animation domain notifications.
static Script<String, JsonObject, Ret0>	enable()	Enables animation domain notifications.
static Script<String, JsonObject, Number>	getCurrentTime(String id)	Returns the current time of the an animation.
static Script<String, JsonObject, Number>	getPlaybackRate()	Gets the playback rate of the document timeline.
static Script<String, JsonObject, Ret0>	releaseAnimations(String[] animations)	Releases a set of animations to no longer be manipulated.
static Script<String, JsonObject, RunTime.RemoteObject>	resolveAnimation(String animationId)	Gets the remote object of the Animation.
static Script<String, JsonObject, Ret0>	seekAnimations(String[] animations, Number currentTime)	Seek a set of animations to a particular time within each animation.
static Script<String, JsonObject, Ret0>	setPaused(String[] animations, boolean paused)	Sets the paused state of a set of animations.
static Script<String, JsonObject, Ret0>	setPlaybackRate(Number playbackRate)	Sets the playback rate of the document timeline.
static Script<String, JsonObject, Ret0>	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.