Class ScriptWorld

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.webkitgtk.webprocessextension.ScriptWorld

All Implemented Interfaces:

Proxy

@Generated("org.javagi.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 GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected ScriptWorld	asParent()	Return 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(@Nullable WebPage page, @Nullable Frame frame)	Emits the "window-object-cleared" signal.
static ScriptWorld	getDefault()	Get the default WebKitScriptWorld.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
String	getName()	Get the name of a WebKitScriptWorld.
static @Nullable 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 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

ScriptWorld

public ScriptWorld(MemorySegment address)

Create a ScriptWorld instance for the provided memory address.

Parameters:

address - the memory address of the native object

ScriptWorld

public ScriptWorld()

Create a new ScriptWorld.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ScriptWorld class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

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

Since:

2.22

getDefault

public static ScriptWorld getDefault()

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

Since:

2.2

getName

public String getName()

Get the name of a WebKitScriptWorld.

Returns:

the name of this ScriptWorld

Since:

2.22

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

Since:

2.2

See Also:

• ScriptWorld.WindowObjectClearedCallback.run(WebPage, Frame)

emitWindowObjectCleared

public void emitWindowObjectCleared(@Nullable WebPage page,
 @Nullable Frame frame)

Emits the "window-object-cleared" signal. See onWindowObjectCleared(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().

Returns:

the builder object