Package Torello.Browser.BrowserAPI

Class Animation.ViewOrScrollTimeline

java.lang.Object

Torello.Browser.BaseType<Animation.ViewOrScrollTimeline>

Torello.Browser.BrowserAPI.Animation.ViewOrScrollTimeline

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BaseType<?>>

Enclosing class:

Animation

public static class Animation.ViewOrScrollTimeline
extends BaseType<Animation.ViewOrScrollTimeline>
implements java.io.Serializable

This Nested Java Class is declared as a "Type", which is similar to a Java Class. The CDP API Specifications list this type among the types, events & commands located in the Animation domain, which may be found within the BrowserAPI.

📌 All browser domain type classes will have a class name that begins with an upper case letter.

Timeline instance

See Also:

Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

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

File Size: 3,037 Bytes Line Count: 79 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc

• View Here: Animation$$ViewOrScrollTimeline$$.java
• Open New Browser-Tab: Animation$$ViewOrScrollTimeline$$.java

File Size: 10,009 Bytes Line Count: 242 '\n' Characters Found

Field Summary

Serializable ID
Modifier and Type	Field	Description
protected static long	serialVersionUID
Type Fields / Properties (from Google & Browser Specs)
Modifier and Type	Field	Description
String	axis	Orientation of the scroll
Number	endOffset	Represents the ending scroll position of the timeline as a length offset in pixels from scroll origin.
Integer	sourceNodeId	Scroll container node
Number	startOffset	Represents the starting scroll position of the timeline as a length offset in pixels from scroll origin.
Integer	subjectNodeId	The element whose principal box's visibility in the scrollport defined the progress of the timeline.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
ViewOrScrollTimeline(ReadOnlyList<Boolean> isPresent, Integer sourceNodeId, Number startOffset, Number endOffset, Integer subjectNodeId, String axis)	Constructor.

Method Summary

Static Builder Convert a JsonObject to a POJO
Modifier and Type	Method	Description
static Animation.ViewOrScrollTimeline	fromJSON(JsonObject jo)	Creates an instance of this class from a JsonObject.
Retrieve the Type-Descriptor Singleton-Instance for this Nested Class.
Modifier and Type	Method	Description
static NestedDescriptor<Animation.ViewOrScrollTimeline>	descriptor()	Returns this class's NestedDescriptor singleton-instance.

Methods inherited from class Torello.Browser.BaseType

allEnumStrROLs, compareTo, enumStrList, enumStrValidate, enumStrValidateThrow, equals, hashCode, isPresent, optionalsValidate, optionalsValidateThrow, toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

🡇 ⇈ ⮫ 🗕 🗗 🗖

protected static final long serialVersionUID

This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.

See Also:

Constant Field Values

sourceNodeId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Integer sourceNodeId

Scroll container node
OPTIONAL

startOffset

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number startOffset

Represents the starting scroll position of the timeline as a length offset in pixels from scroll origin.
OPTIONAL

endOffset

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number endOffset

Represents the ending scroll position of the timeline as a length offset in pixels from scroll origin.
OPTIONAL

subjectNodeId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Integer subjectNodeId

The element whose principal box's visibility in the scrollport defined the progress of the timeline. Does not exist for animations with ScrollTimeline
OPTIONAL

axis

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String axis

Orientation of the scroll

This particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed here:

📎 DOM.ScrollOrientation

Programmatically Accessing the Enum:

// Retrieve the list of enumerated strings for this field
ReadOnlyList<String> enumerationStrs = DOM.ScrollOrientation.enumStrList("axis");

// Print the list of strings to the terminal
for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");

See Also:

BaseType.enumStrList(String)

Constructor Detail

ViewOrScrollTimeline

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public ViewOrScrollTimeline(ReadOnlyList<java.lang.Boolean> isPresent,
                            java.lang.Integer sourceNodeId,
                            java.lang.Number startOffset,
                            java.lang.Number endOffset,
                            java.lang.Integer subjectNodeId,
                            java.lang.String axis)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Animation.ViewOrScrollTimeline fromJSON(JsonObject jo)

Creates an instance of this class from a JsonObject.

Code:

Exact Method Body:

 return singleton.fromJSON(jo);

descriptor

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static NestedDescriptor<Animation.ViewOrScrollTimeline> descriptor()

Returns this class's NestedDescriptor singleton-instance. class / type.

Code:

Exact Method Body:

 return singleton.descriptor();