Class Frame

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.webkitgtk.webprocessextension.Frame

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public final class Frame
extends GObject

A web page frame.

Each WebKitWebPage has at least one main frame, and can have any number of subframes.

Since:

2.26

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Frame.Builder<B extends Frame.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	Frame.FrameClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
Frame()	Create a new Frame.
Frame(MemorySegment address)	Create a Frame instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected Frame	asParent()	Return this instance as if it were its parent type.
static Frame.Builder<? extends Frame.Builder>	builder()	A Frame.Builder object constructs a Frame with the specified properties.
long	getId()	Gets the process-unique identifier of this WebKitFrame.
Context	getJsContext()	Get the JavaScript execution context of frame. Use this function to bridge between the WebKit and JavaScriptCore APIs.
Context	getJsContextForScriptWorld(ScriptWorld world)	Get the JavaScript execution context of this Frame for the given WebKitScriptWorld.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the Frame class.
String	getUri()	Gets the current active URI of frame.
boolean	isMainFrame()	Gets whether this Frame is the main frame of a WebKitWebPage

Methods inherited from class GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Constructor Details

Frame

public Frame(MemorySegment address)

Create a Frame instance for the provided memory address.

Parameters:

address - the memory address of the native object

Frame

public Frame()

Create a new Frame.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Frame class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Frame asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class GObject

Returns:

the instance as if it were its parent type

getId

public long getId()

Gets the process-unique identifier of this WebKitFrame. No other frame in the same web process will have the same ID; however, frames in other web processes may.

Returns:

the identifier of this Frame

Since:

2.26

getJsContext

public Context getJsContext()

Get the JavaScript execution context of frame. Use this function to bridge between the WebKit and JavaScriptCore APIs.

Returns:

the JSCContext for the JavaScript execution context of frame.

Since:

2.22

getJsContextForScriptWorld

public Context getJsContextForScriptWorld(ScriptWorld world)

Get the JavaScript execution context of this Frame for the given WebKitScriptWorld.

Parameters:

world - a WebKitScriptWorld

Returns:

the JSCContext for the JavaScript execution context of this Frame for world.

Since:

2.22

getUri

public String getUri()

Gets the current active URI of frame.

Returns:

the current active URI of this Frame or null if nothing has been loaded yet.

Since:

2.2

isMainFrame

public boolean isMainFrame()

Gets whether this Frame is the main frame of a WebKitWebPage

Returns:

true if this Frame is a main frame or false otherwise

Since:

2.2

builder

public static Frame.Builder<? extends Frame.Builder> builder()

A Frame.Builder object constructs a Frame with the specified properties. Use the various set...() methods to set properties, and finish construction with Frame.Builder.build().

Returns:

the builder object