Package org.gnome.webkit.wpe

Class Frame

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.webkit.wpe.Frame

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.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.

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 org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Frame	asParent()	Returns 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 this Frame.
Context	getJsContextForScriptWorld(ScriptWorld world)	Get the JavaScript execution context of this Frame for the given WebKitScriptWorld.
static Type	getType()	Get the GType of the Frame class
String	getUri()	Gets the current active URI of this Frame.
boolean	isMainFrame()	Gets whether this Frame is the main frame of a WebKitWebPage

Methods inherited from class org.gnome.gobject.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, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, 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 org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

Frame

public Frame(MemorySegment address)

Create a Frame proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the Frame class

Returns:

the GType

asParent

protected Frame asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

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

getJsContext

public Context getJsContext()

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

Returns:

the JSCContext for the JavaScript execution context of this Frame.

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.

getUri

public String getUri()

Gets the current active URI of this Frame.

Returns:

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

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

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().