Package org.webkitgtk.webprocessextension

Class WebPage

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.webkitgtk.webprocessextension.WebPage

All Implemented Interfaces:

Proxy

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

A loaded web page.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebPage.Builder<B extends WebPage.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	WebPage.ConsoleMessageSentCallback	Functional interface declaration of the ConsoleMessageSentCallback callback.
static interface	WebPage.ContextMenuCallback	Functional interface declaration of the ContextMenuCallback callback.
static interface	WebPage.DocumentLoadedCallback	Functional interface declaration of the DocumentLoadedCallback callback.
static interface	WebPage.SendRequestCallback	Functional interface declaration of the SendRequestCallback callback.
static interface	WebPage.UserMessageReceivedCallback	Functional interface declaration of the UserMessageReceivedCallback callback.
static class	WebPage.WebPageClass

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected WebPage	asParent()	Returns this instance as if it were its parent type.
static WebPage.Builder<? extends WebPage.Builder>	builder()	A WebPage.Builder object constructs a WebPage with the specified properties.
void	emitConsoleMessageSent(@Nullable ConsoleMessage consoleMessage)	Emits the "console-message-sent" signal.
boolean	emitContextMenu(@Nullable ContextMenu contextMenu, @Nullable WebHitTestResult hitTestResult)	Emits the "context-menu" signal.
void	emitDocumentLoaded()	Emits the "document-loaded" signal.
boolean	emitSendRequest(@Nullable URIRequest request, @Nullable URIResponse redirectedResponse)	Emits the "send-request" signal.
boolean	emitUserMessageReceived(@Nullable UserMessage message)	Emits the "user-message-received" signal.
WebEditor	getEditor()	Gets the WebKitWebEditor of a WebKitWebPage.
WebFormManager	getFormManager(@Nullable ScriptWorld world)	Get the WebKitWebFormManager of this WebPage in world.
long	getId()	Get the identifier of the WebKitWebPage
Frame	getMainFrame()	Deprecated.
static @Nullable Type	getType()	Get the GType of the WebPage class
String	getUri()	Returns the current active URI of webPage.
SignalConnection<WebPage.ConsoleMessageSentCallback>	onConsoleMessageSent(WebPage.ConsoleMessageSentCallback handler)	Emitted when a message is sent to the console.
SignalConnection<WebPage.ContextMenuCallback>	onContextMenu(WebPage.ContextMenuCallback handler)	Emitted before a context menu is displayed in the UI Process to give the application a chance to customize the proposed menu, build its own context menu or pass user data to the UI Process.
SignalConnection<WebPage.DocumentLoadedCallback>	onDocumentLoaded(WebPage.DocumentLoadedCallback handler)	This signal is emitted when the DOM document of a WebKitWebPage has been loaded.
SignalConnection<WebPage.SendRequestCallback>	onSendRequest(WebPage.SendRequestCallback handler)	This signal is emitted when request is about to be sent to the server.
SignalConnection<WebPage.UserMessageReceivedCallback>	onUserMessageReceived(WebPage.UserMessageReceivedCallback handler)	This signal is emitted when a WebKitUserMessage is received from the WebKitWebView corresponding to webPage. You can reply to the message using webkit_user_message_send_reply().
void	sendMessageToView(UserMessage message, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Send message to the WebKitWebView corresponding to webPage. If message is floating, it's consumed.
UserMessage	sendMessageToViewFinish(AsyncResult result)	Finish an asynchronous operation started with webkit_web_page_send_message_to_view().

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, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

WebPage

public WebPage(MemorySegment address)

Create a WebPage proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

WebPage

public WebPage()

Creates a new WebPage.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the WebPage class

Returns:

the GType

asParent

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

getEditor

public WebEditor getEditor()

Gets the WebKitWebEditor of a WebKitWebPage.

Returns:

the WebKitWebEditor

Since:

2.10

getFormManager

public WebFormManager getFormManager(@Nullable ScriptWorld world)

Get the WebKitWebFormManager of this WebPage in world.

Parameters:

world - a WebKitScriptWorld

Returns:

a WebKitWebFormManager

Since:

2.40

getId

public long getId()

Get the identifier of the WebKitWebPage

Returns:

the identifier of this WebPage

getMainFrame

@Deprecated
public Frame getMainFrame()

Deprecated.

Returns the main frame of a WebKitWebPage.

Returns:

the WebKitFrame that is the main frame of this WebPage

Since:

2.2

getUri

public String getUri()

Returns the current active URI of webPage.

You can monitor the active URI by connecting to the notify::uri signal of webPage.

Returns:

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

sendMessageToView

public void sendMessageToView(UserMessage message,
 @Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

Send message to the WebKitWebView corresponding to webPage. If message is floating, it's consumed.

If you don't expect any reply, or you simply want to ignore it, you can pass null as callback. When the operation is finished, callback will be called. You can then call webkit_web_page_send_message_to_view_finish() to get the message reply.

Parameters:

message - a WebKitUserMessage

cancellable - a GCancellable or null to ignore

callback - A GAsyncReadyCallback to call when the request is satisfied or null

Since:

2.28

sendMessageToViewFinish

public UserMessage sendMessageToViewFinish(AsyncResult result)
                                    throws GErrorException

Finish an asynchronous operation started with webkit_web_page_send_message_to_view().

Parameters:

result - a GAsyncResult

Returns:

a WebKitUserMessage with the reply or null in case of error.

Throws:

GErrorException - see GError

Since:

2.28

onConsoleMessageSent

public SignalConnection<WebPage.ConsoleMessageSentCallback> onConsoleMessageSent(WebPage.ConsoleMessageSentCallback handler)

Emitted when a message is sent to the console. This can be a message produced by the use of JavaScript console API, a JavaScript exception, a security error or other errors, warnings, debug or log messages. The consoleMessage contains information of the message.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

2.12

See Also:

• WebPage.ConsoleMessageSentCallback.run(org.webkitgtk.webprocessextension.ConsoleMessage)

emitConsoleMessageSent

public void emitConsoleMessageSent(@Nullable ConsoleMessage consoleMessage)

Emits the "console-message-sent" signal. See onConsoleMessageSent(org.webkitgtk.webprocessextension.WebPage.ConsoleMessageSentCallback).

onContextMenu

public SignalConnection<WebPage.ContextMenuCallback> onContextMenu(WebPage.ContextMenuCallback handler)

Emitted before a context menu is displayed in the UI Process to give the application a chance to customize the proposed menu, build its own context menu or pass user data to the UI Process. This signal is useful when the information available in the UI Process is not enough to build or customize the context menu, for example, to add menu entries depending on the node at the coordinates of the hitTestResult. Otherwise, it's recommended to use WebKitWebView::context-menu signal instead.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

2.8

See Also:

• WebPage.ContextMenuCallback.run(org.webkitgtk.webprocessextension.ContextMenu, org.webkitgtk.webprocessextension.WebHitTestResult)

emitContextMenu

public boolean emitContextMenu(@Nullable ContextMenu contextMenu,
 @Nullable WebHitTestResult hitTestResult)

Emits the "context-menu" signal. See onContextMenu(org.webkitgtk.webprocessextension.WebPage.ContextMenuCallback).

onDocumentLoaded

public SignalConnection<WebPage.DocumentLoadedCallback> onDocumentLoaded(WebPage.DocumentLoadedCallback handler)

This signal is emitted when the DOM document of a WebKitWebPage has been loaded.

You can wait for this signal to get the DOM document

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebPage.DocumentLoadedCallback.run()

emitDocumentLoaded

public void emitDocumentLoaded()

Emits the "document-loaded" signal. See onDocumentLoaded(org.webkitgtk.webprocessextension.WebPage.DocumentLoadedCallback).

onSendRequest

public SignalConnection<WebPage.SendRequestCallback> onSendRequest(WebPage.SendRequestCallback handler)

This signal is emitted when request is about to be sent to the server. This signal can be used to modify the WebKitURIRequest that will be sent to the server. You can also cancel the resource load operation by connecting to this signal and returning true.

In case of a server redirection this signal is emitted again with the request argument containing the new request to be sent to the server due to the redirection and the redirectedResponse parameter containing the response received by the server for the initial request.

Modifications to the WebKitURIRequest and its associated SoupMessageHeaders will be taken into account when the request is sent over the network.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebPage.SendRequestCallback.run(org.webkitgtk.webprocessextension.URIRequest, org.webkitgtk.webprocessextension.URIResponse)

emitSendRequest

public boolean emitSendRequest(@Nullable URIRequest request,
 @Nullable URIResponse redirectedResponse)

Emits the "send-request" signal. See onSendRequest(org.webkitgtk.webprocessextension.WebPage.SendRequestCallback).

onUserMessageReceived

public SignalConnection<WebPage.UserMessageReceivedCallback> onUserMessageReceived(WebPage.UserMessageReceivedCallback handler)

This signal is emitted when a WebKitUserMessage is received from the WebKitWebView corresponding to webPage. You can reply to the message using webkit_user_message_send_reply().

You can handle the user message asynchronously by calling g_object_ref() on message and returning true. If the last reference of message is removed and the message has been replied, the operation in the WebKitWebView will finish with error UserMessageError.USER_MESSAGE_UNHANDLED_MESSAGE.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

2.28

See Also:

• WebPage.UserMessageReceivedCallback.run(org.webkitgtk.webprocessextension.UserMessage)

emitUserMessageReceived

public boolean emitUserMessageReceived(@Nullable UserMessage message)

Emits the "user-message-received" signal. See onUserMessageReceived(org.webkitgtk.webprocessextension.WebPage.UserMessageReceivedCallback).

builder

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

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

Returns:

the builder object