Package org.gnome.webkit

Class UserContentManager

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.webkit.UserContentManager

All Implemented Interfaces:

Proxy

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

Manages user-defined content which affects web pages.

Using a WebKitUserContentManager user CSS style sheets can be set to be injected in the web pages loaded by a WebKitWebView, by webkit_user_content_manager_add_style_sheet().

To use a WebKitUserContentManager, it must be created using webkit_user_content_manager_new(), and then used to construct a WebKitWebView. User style sheets can be created with webkit_user_style_sheet_new().

User style sheets can be added and removed at any time, but they will affect the web pages loaded afterwards.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
UserContentManager()	Creates a new user content manager.
UserContentManager(MemorySegment address)	Create a UserContentManager proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	addFilter(UserContentFilter filter)	Adds a WebKitUserContentFilter to the given WebKitUserContentManager.
void	addScript(UserScript script)	Adds a WebKitUserScript to the given WebKitUserContentManager.
void	addStyleSheet(UserStyleSheet stylesheet)	Adds a WebKitUserStyleSheet to the given WebKitUserContentManager.
protected UserContentManager	asParent()	Returns this instance as if it were its parent type.
static UserContentManager.Builder<? extends UserContentManager.Builder>	builder()	A UserContentManager.Builder object constructs a UserContentManager with the specified properties.
void	emitScriptMessageReceived(@Nullable String detail, Value value)	Emits the "script-message-received" signal.
boolean	emitScriptMessageWithReplyReceived(@Nullable String detail, Value value, ScriptMessageReply reply)	Emits the "script-message-with-reply-received" signal.
static Type	getType()	Get the GType of the UserContentManager class
SignalConnection<UserContentManager.ScriptMessageReceivedCallback>	onScriptMessageReceived(@Nullable String detail, UserContentManager.ScriptMessageReceivedCallback handler)	This signal is emitted when JavaScript in a web view calls <code>window.webkit.messageHandlers.<name>.postMessage()</code>, after registering <code><name></code> using webkit_user_content_manager_register_script_message_handler()
SignalConnection<UserContentManager.ScriptMessageWithReplyReceivedCallback>	onScriptMessageWithReplyReceived(@Nullable String detail, UserContentManager.ScriptMessageWithReplyReceivedCallback handler)	This signal is emitted when JavaScript in a web view calls <code>window.webkit.messageHandlers.<name>.postMessage()</code>, after registering <code><name></code> using webkit_user_content_manager_register_script_message_handler_with_reply()
boolean	registerScriptMessageHandler(String name, @Nullable String worldName)	Registers a new user script message handler in script world.
boolean	registerScriptMessageHandlerWithReply(String name, @Nullable String worldName)	Registers a new user script message handler in script world with name worldName.
void	removeAllFilters()	Removes all content filters from the given WebKitUserContentManager.
void	removeAllScripts()	Removes all user scripts from the given WebKitUserContentManager
void	removeAllStyleSheets()	Removes all user style sheets from the given WebKitUserContentManager.
void	removeFilter(UserContentFilter filter)	Removes a filter from the given WebKitUserContentManager.
void	removeFilterById(String filterId)	Removes a filter by the given identifier.
void	removeScript(UserScript script)	Removes a WebKitUserScript from the given WebKitUserContentManager.
void	removeStyleSheet(UserStyleSheet stylesheet)	Removes a WebKitUserStyleSheet from the given WebKitUserContentManager.
void	unregisterScriptMessageHandler(String name, @Nullable String worldName)	Unregisters a previously registered message handler in script world with name worldName.

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

UserContentManager

public UserContentManager(MemorySegment address)

Create a UserContentManager proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

UserContentManager

public UserContentManager()
                   throws UnsupportedPlatformException

Creates a new user content manager.

Throws:

UnsupportedPlatformException - when run on a platform other than linux

Method Details

getType

public static Type getType()

Get the GType of the UserContentManager class

Returns:

the GType

asParent

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

addFilter

public void addFilter(UserContentFilter filter)

Adds a WebKitUserContentFilter to the given WebKitUserContentManager.

The same WebKitUserContentFilter can be reused with multiple WebKitUserContentManager instances.

Filters need to be saved and loaded from WebKitUserContentFilterStore.

Parameters:

filter - A WebKitUserContentFilter

addScript

public void addScript(UserScript script)

Adds a WebKitUserScript to the given WebKitUserContentManager.

The same WebKitUserScript can be reused with multiple WebKitUserContentManager instances.

Parameters:

script - A WebKitUserScript

addStyleSheet

public void addStyleSheet(UserStyleSheet stylesheet)

Adds a WebKitUserStyleSheet to the given WebKitUserContentManager.

The same WebKitUserStyleSheet can be reused with multiple WebKitUserContentManager instances.

Parameters:

stylesheet - A WebKitUserStyleSheet

registerScriptMessageHandler

public boolean registerScriptMessageHandler(String name,
 @Nullable
 @Nullable String worldName)

Registers a new user script message handler in script world.

After it is registered, scripts can use window.webkit.messageHandlers.<name>.postMessage(value) to send messages. Those messages are received by connecting handlers to the WebKitUserContentManager::script-message-received signal. The handler name is used as the detail of the signal. To avoid race conditions between registering the handler name, and starting to receive the signals, it is recommended to connect to the signal before registering the handler name:

WebKitWebView *view = webkit_web_view_new ();
 WebKitUserContentManager *manager = webkit_web_view_get_user_content_manager ();
 g_signal_connect (manager, "script-message-received::foobar",
                   G_CALLBACK (handle_script_message), NULL);
 webkit_user_content_manager_register_script_message_handler (manager, "foobar");
 

Registering a script message handler will fail if the requested name has been already registered before.

If null is passed as the worldName, the default world will be used.

The registered handler can be unregistered by using webkit_user_content_manager_unregister_script_message_handler().

Parameters:

name - Name of the script message channel

worldName - the name of a WebKitScriptWorld

Returns:

true if message handler was registered successfully, or false otherwise.

registerScriptMessageHandlerWithReply

public boolean registerScriptMessageHandlerWithReply(String name,
 @Nullable
 @Nullable String worldName)

Registers a new user script message handler in script world with name worldName.

Different from webkit_user_content_manager_register_script_message_handler(), when using this function to register the handler, the connected signal is script-message-with-reply-received, and a reply provided by the user is expected. Otherwise, the user will receive a default undefined value.

If null is passed as the worldName, the default world will be used. See webkit_user_content_manager_register_script_message_handler() for full description.

Registering a script message handler will fail if the requested name has been already registered before.

The registered handler can be unregistered by using webkit_user_content_manager_unregister_script_message_handler().

Parameters:

name - Name of the script message channel

worldName - the name of a WebKitScriptWorld

Returns:

true if message handler was registered successfully, or false otherwise.

removeAllFilters

public void removeAllFilters()

Removes all content filters from the given WebKitUserContentManager.

removeAllScripts

public void removeAllScripts()

Removes all user scripts from the given WebKitUserContentManager

See also webkit_user_content_manager_remove_script().

removeAllStyleSheets

public void removeAllStyleSheets()

Removes all user style sheets from the given WebKitUserContentManager.

removeFilter

public void removeFilter(UserContentFilter filter)

Removes a filter from the given WebKitUserContentManager.

Since 2.24

Parameters:

filter - A WebKitUserContentFilter

removeFilterById

public void removeFilterById(String filterId)

Removes a filter by the given identifier.

Removes a filter from the given WebKitUserContentManager given the identifier of a WebKitUserContentFilter as returned by webkit_user_content_filter_get_identifier().

Parameters:

filterId - Filter identifier

removeScript

public void removeScript(UserScript script)

Removes a WebKitUserScript from the given WebKitUserContentManager.

See also webkit_user_content_manager_remove_all_scripts().

Parameters:

script - A WebKitUserScript

removeStyleSheet

public void removeStyleSheet(UserStyleSheet stylesheet)

Removes a WebKitUserStyleSheet from the given WebKitUserContentManager.

See also webkit_user_content_manager_remove_all_style_sheets().

Parameters:

stylesheet - A WebKitUserStyleSheet

unregisterScriptMessageHandler

public void unregisterScriptMessageHandler(String name,
 @Nullable
 @Nullable String worldName)

Unregisters a previously registered message handler in script world with name worldName. If null is passed as the worldName, the default world will be used.

Note that this does not disconnect handlers for the WebKitUserContentManager::script-message-received signal; they will be kept connected, but the signal will not be emitted unless the handler name is registered again.

See also webkit_user_content_manager_register_script_message_handler().

Parameters:

name - Name of the script message channel

worldName - the name of a WebKitScriptWorld

onScriptMessageReceived

public SignalConnection<UserContentManager.ScriptMessageReceivedCallback> onScriptMessageReceived(@Nullable
 @Nullable String detail,
 UserContentManager.ScriptMessageReceivedCallback handler)

This signal is emitted when JavaScript in a web view calls <code>window.webkit.messageHandlers.<name>.postMessage()</code>, after registering <code><name></code> using webkit_user_content_manager_register_script_message_handler()

Parameters:

detail - the signal detail

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• UserContentManager.ScriptMessageReceivedCallback.run(org.gnome.webkit.jsc.Value)

emitScriptMessageReceived

public void emitScriptMessageReceived(@Nullable
 @Nullable String detail,
 Value value)

Emits the "script-message-received" signal. See onScriptMessageReceived(java.lang.String, org.gnome.webkit.UserContentManager.ScriptMessageReceivedCallback).

onScriptMessageWithReplyReceived

public SignalConnection<UserContentManager.ScriptMessageWithReplyReceivedCallback> onScriptMessageWithReplyReceived(@Nullable
 @Nullable String detail,
 UserContentManager.ScriptMessageWithReplyReceivedCallback handler)

This signal is emitted when JavaScript in a web view calls <code>window.webkit.messageHandlers.<name>.postMessage()</code>, after registering <code><name></code> using webkit_user_content_manager_register_script_message_handler_with_reply()

The given reply can be used to send a return value with webkit_script_message_reply_return_value() or an error message with webkit_script_message_reply_return_error_message(). If none of them are called, an automatic reply with an undefined value will be sent.

It is possible to handle the reply asynchronously, by simply calling g_object_ref() on the reply and returning true.

Parameters:

detail - the signal detail

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• UserContentManager.ScriptMessageWithReplyReceivedCallback.run(org.gnome.webkit.jsc.Value, org.gnome.webkit.ScriptMessageReply)

emitScriptMessageWithReplyReceived

public boolean emitScriptMessageWithReplyReceived(@Nullable
 @Nullable String detail,
 Value value,
 ScriptMessageReply reply)

Emits the "script-message-with-reply-received" signal. See onScriptMessageWithReplyReceived(java.lang.String, org.gnome.webkit.UserContentManager.ScriptMessageWithReplyReceivedCallback).

builder

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

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