Package org.gnome.webkit.wpe

Class ScriptWorld

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.webkit.wpe.ScriptWorld

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class ScriptWorld
extends GObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScriptWorld.Builder<B extends ScriptWorld.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	ScriptWorld.ScriptWorldClass
static interface	ScriptWorld.WindowObjectClearedCallback	Functional interface declaration of the WindowObjectClearedCallback callback.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
ScriptWorld()	Creates a new isolated WebKitScriptWorld.
ScriptWorld(MemorySegment address)	Create a ScriptWorld proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected ScriptWorld	asParent()	Returns this instance as if it were its parent type.
static ScriptWorld.Builder<? extends ScriptWorld.Builder>	builder()	A ScriptWorld.Builder object constructs a ScriptWorld with the specified properties.
void	emitWindowObjectCleared(WebPage page, Frame frame)	Emits the "window-object-cleared" signal.
static ScriptWorld	getDefault()	Get the default WebKitScriptWorld.
String	getName()	Get the name of a WebKitScriptWorld.
static Type	getType()	Get the GType of the ScriptWorld class
SignalConnection<ScriptWorld.WindowObjectClearedCallback>	onWindowObjectCleared(ScriptWorld.WindowObjectClearedCallback handler)	Emitted when the JavaScript window object in a WebKitScriptWorld has been cleared.
static ScriptWorld	withName(String name)	Creates a new isolated WebKitScriptWorld with a name.

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, 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

ScriptWorld

public ScriptWorld(MemorySegment address)

Create a ScriptWorld proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ScriptWorld

public ScriptWorld()
            throws UnsupportedPlatformException

Creates a new isolated WebKitScriptWorld. Scripts executed in isolated worlds have access to the DOM but not to other variable or functions created by the page. The WebKitScriptWorld is created with a generated unique name. Use webkit_script_world_new_with_name() if you want to create it with a custom name. You can get the JavaScript execution context of a WebKitScriptWorld for a given WebKitFrame with webkit_frame_get_javascript_context_for_script_world().

Throws:

UnsupportedPlatformException - when run on a platform other than linux

Method Details

getType

public static Type getType()

Get the GType of the ScriptWorld class

Returns:

the GType

asParent

protected ScriptWorld 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

withName

public static ScriptWorld withName(String name)

Creates a new isolated WebKitScriptWorld with a name. Scripts executed in isolated worlds have access to the DOM but not to other variable or functions created by the page. You can get the JavaScript execution context of a WebKitScriptWorld for a given WebKitFrame with webkit_frame_get_javascript_context_for_script_world().

Parameters:

name - a name for the script world

Returns:

a new isolated WebKitScriptWorld

Throws:

UnsupportedPlatformException - when run on a platform other than linux

getDefault

public static ScriptWorld getDefault()
                              throws UnsupportedPlatformException

Get the default WebKitScriptWorld. This is the normal script world where all scripts are executed by default. You can get the JavaScript execution context of a WebKitScriptWorld for a given WebKitFrame with webkit_frame_get_javascript_context_for_script_world().

Returns:

the default WebKitScriptWorld

Throws:

UnsupportedPlatformException - when run on a platform other than linux

getName

public String getName()

Get the name of a WebKitScriptWorld.

Returns:

the name of this ScriptWorld

onWindowObjectCleared

public SignalConnection<ScriptWorld.WindowObjectClearedCallback> onWindowObjectCleared(ScriptWorld.WindowObjectClearedCallback handler)

Emitted when the JavaScript window object in a WebKitScriptWorld has been cleared. This is the preferred place to set custom properties on the window object using the JavaScriptCore API. You can get the window object of frame from the JavaScript execution context of world that is returned by webkit_frame_get_js_context_for_script_world().

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• ScriptWorld.WindowObjectClearedCallback.run(org.gnome.webkit.wpe.WebPage, org.gnome.webkit.wpe.Frame)

emitWindowObjectCleared

public void emitWindowObjectCleared(WebPage page,
 Frame frame)

Emits the "window-object-cleared" signal. See onWindowObjectCleared(org.gnome.webkit.wpe.ScriptWorld.WindowObjectClearedCallback).

builder

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

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