Package org.gnome.webkit.wpe

Class WebFormManager.Builder<B extends WebFormManager.Builder<B>>

java.lang.Object

io.github.jwharm.javagi.gobject.Builder<B>

org.gnome.gobject.GObject.Builder<B>

org.gnome.webkit.wpe.WebFormManager.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Enclosing class:

WebFormManager

public static class WebFormManager.Builder<B extends WebFormManager.Builder<B>>
extends GObject.Builder<B>

Inner class implementing a builder pattern to construct a GObject with properties.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Default constructor for a Builder object.

Method Summary

Modifier and Type	Method	Description
WebFormManager	build()	Finish building the WebFormManager object.
B	onFormControlsAssociated(WebFormManager.FormControlsAssociatedCallback handler)	Emitted after form elements (or form associated elements) are associated to frame.
B	onWillSendSubmitEvent(WebFormManager.WillSendSubmitEventCallback handler)	This signal is emitted when the DOM submit event is about to be fired for form.
B	onWillSubmitForm(WebFormManager.WillSubmitFormCallback handler)	This signal is emitted when form will imminently be submitted.

Methods inherited from class org.gnome.gobject.GObject.Builder

onNotify

Methods inherited from class io.github.jwharm.javagi.gobject.Builder

addBuilderProperty, connect, connect, connectSignals, getArena, getNames, getValues

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public WebFormManager build()
                     throws UnsupportedPlatformException

Finish building the WebFormManager object. This will call GObject.withProperties(org.gnome.glib.Type, java.lang.String[], org.gnome.gobject.Value[]) to create a new GObject instance, which is then cast to WebFormManager.

Overrides:

build in class GObject.Builder<B extends WebFormManager.Builder<B>>

Returns:

a new instance of WebFormManager with the properties that were set in the Builder object.

Throws:

UnsupportedPlatformException - when run on an unsupported platform

onFormControlsAssociated

public B onFormControlsAssociated(WebFormManager.FormControlsAssociatedCallback handler)

Emitted after form elements (or form associated elements) are associated to frame. This is useful to implement form auto filling for web pages where form fields are added dynamically. This signal might be emitted multiple times for the same frame.

Note that this signal could be also emitted when form controls are moved between forms. In that case, the elements array carries the list of those elements which have moved.

Clients should take a reference to the members of the elements array if it is desired to keep them alive after the signal handler returns.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• WebFormManager.FormControlsAssociatedCallback.run(org.gnome.webkit.wpe.Frame, org.gnome.webkit.jsc.Value[])

onWillSendSubmitEvent

public B onWillSendSubmitEvent(WebFormManager.WillSendSubmitEventCallback handler)

This signal is emitted when the DOM submit event is about to be fired for form. JavaScript code may rely on the submit event to detect that the user has clicked on a submit button, and to possibly cancel the form submission before WebKitWebFormManager::will-submit-form signal is emitted. However, beware that, for historical reasons, the submit event is not emitted at all if the form submission is triggered by JavaScript. For these reasons, this signal may not be used to reliably detect whether a form will be submitted. Instead, use it to detect if a user has clicked on a form's submit button even if JavaScript later cancels the form submission, or to read the values of the form's fields even if JavaScript later clears certain fields before submitting. This may be needed, for example, to implement a robust browser password manager, as some misguided websites may use such techniques to attempt to thwart password managers.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• WebFormManager.WillSendSubmitEventCallback.run(org.gnome.webkit.jsc.Value, org.gnome.webkit.wpe.Frame, org.gnome.webkit.wpe.Frame)

onWillSubmitForm

public B onWillSubmitForm(WebFormManager.WillSubmitFormCallback handler)

This signal is emitted when form will imminently be submitted. It can no longer be cancelled. This event always occurs immediately before a form is submitted to its target, so use this event to reliably detect when a form is submitted. This signal is emitted after WebKitWebFormManager::will-send-submit-event if that signal is emitted.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• WebFormManager.WillSubmitFormCallback.run(org.gnome.webkit.jsc.Value, org.gnome.webkit.wpe.Frame, org.gnome.webkit.wpe.Frame)