Package Torello.Browser.BrowserAPI

Class Page.getLayoutMetrics$$RET

java.lang.Object

Torello.Browser.BaseType<Page.getLayoutMetrics$$RET>

Torello.Browser.BrowserAPI.Page.getLayoutMetrics$$RET

All Implemented Interfaces:

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

Enclosing class:

Page

public static class Page.getLayoutMetrics$$RET
extends BaseType<Page.getLayoutMetrics$$RET>
implements java.io.Serializable

This Nested Java Class was written in order to incorporate the litany of all return-values from the browser command getLayoutMetrics. This command is defined in the Page domain, which is located in the BrowserAPI.

📌 All browser commands having a dedicated return type nested class will have a name which begins with a lower case letter, and ends with the string '$$RET'.

⚠️ Browser return types are only created for commands in which 2 or more values are returned by a CDP command.

Returns metrics relating to the layouting of the page, such as viewport bounds/scale.

See Also:

Page.getLayoutMetrics(), Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

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

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

• View Here: Page$$getLayoutMetrics$$RET.java
• Open New Browser-Tab: Page$$getLayoutMetrics$$RET.java

File Size: 11,286 Bytes Line Count: 272 '\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
DOM.Rect	contentSize	Deprecated size of scrollable area.
DOM.Rect	cssContentSize	Size of scrollable area in CSS pixels.
Page.LayoutViewport	cssLayoutViewport	Metrics relating to the layout viewport in CSS pixels.
Page.VisualViewport	cssVisualViewport	Metrics relating to the visual viewport in CSS pixels.
Page.LayoutViewport	layoutViewport	Deprecated metrics relating to the layout viewport.
Page.VisualViewport	visualViewport	Deprecated metrics relating to the visual viewport.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
getLayoutMetrics$$RET(ReadOnlyList<Boolean> isPresent, Page.LayoutViewport layoutViewport, Page.VisualViewport visualViewport, DOM.Rect contentSize, Page.LayoutViewport cssLayoutViewport, Page.VisualViewport cssVisualViewport, DOM.Rect cssContentSize)	Constructor.

Method Summary

Static Builder Convert a JsonObject to a POJO
Modifier and Type	Method	Description
static Page.getLayoutMetrics$$RET	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<Page.getLayoutMetrics$$RET>	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

layoutViewport

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final Page.LayoutViewport layoutViewport

Deprecated metrics relating to the layout viewport. Is in device pixels. Use cssLayoutViewport instead.
DEPRECATED

visualViewport

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final Page.VisualViewport visualViewport

Deprecated metrics relating to the visual viewport. Is in device pixels. Use cssVisualViewport instead.
DEPRECATED

contentSize

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOM.Rect contentSize

Deprecated size of scrollable area. Is in DP. Use cssContentSize instead.
DEPRECATED

cssLayoutViewport

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final Page.LayoutViewport cssLayoutViewport

Metrics relating to the layout viewport in CSS pixels.

cssVisualViewport

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final Page.VisualViewport cssVisualViewport

Metrics relating to the visual viewport in CSS pixels.

cssContentSize

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOM.Rect cssContentSize

Size of scrollable area in CSS pixels.

Constructor Detail

getLayoutMetrics$$RET

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public getLayoutMetrics$$RET(ReadOnlyList<java.lang.Boolean> isPresent,
                             Page.LayoutViewport layoutViewport,
                             Page.VisualViewport visualViewport,
                             DOM.Rect contentSize,
                             Page.LayoutViewport cssLayoutViewport,
                             Page.VisualViewport cssVisualViewport,
                             DOM.Rect cssContentSize)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Page.getLayoutMetrics$$RET fromJSON(JsonObject jo)

Creates an instance of this class from a JsonObject.

Code:

Exact Method Body:

 return singleton.fromJSON(jo);

descriptor

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static NestedDescriptor<Page.getLayoutMetrics$$RET> descriptor()

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

Code:

Exact Method Body:

 return singleton.descriptor();