Package org.webkitgtk.webprocessextension

Class WebHitTestResult

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.webkitgtk.webprocessextension.WebHitTestResult

All Implemented Interfaces:

Proxy

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

Result of a Hit Test (Web Process Extensions).

WebKitWebHitTestResult extends WebKitHitTestResult to provide information about the WebKitDOMNode in the coordinates of the Hit Test.

Since:

2.8

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebHitTestResult.Builder<B extends WebHitTestResult.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	WebHitTestResult.WebHitTestResultClass

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected WebHitTestResult	asParent()	Returns this instance as if it were its parent type.
static WebHitTestResult.Builder<? extends WebHitTestResult.Builder>	builder()	A WebHitTestResult.Builder object constructs a WebHitTestResult with the specified properties.
boolean	contextIsEditable()	Check whether there is an editable element at the hit test position.
boolean	contextIsImage()	Check whether there is an image element at the hit test position.
boolean	contextIsLink()	Check whether there is a link element at the hit test position.
boolean	contextIsMedia()	Check whether there is a media element at the hit test position.
boolean	contextIsScrollbar()	Check whether there is a scrollbar at the hit test position.
boolean	contextIsSelection()	Check whether there is a selected element at the hit test position.
int	getContext()	Gets the the context flags for the hit test result.
String	getImageUri()	Obtains the URI associated with the image element at the hit test position.
@Nullable Value	getJsNode(@Nullable ScriptWorld world)	Get the JSCValue for the DOM node in world at the coordinates of the Hit Test.
String	getLinkLabel()	Obtains the label associated with the link element at the hit test position.
String	getLinkTitle()	Obtains the title associated with the link element at the hit test position.
String	getLinkUri()	Obtains the URI associated with the link element at the hit test position.
String	getMediaUri()	Obtains the URI associated with the media element at the hit test position.
static @Nullable Type	getType()	Get the GType of the WebHitTestResult class

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

WebHitTestResult

public WebHitTestResult(MemorySegment address)

Create a WebHitTestResult proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

WebHitTestResult

public WebHitTestResult()

Creates a new WebHitTestResult.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the WebHitTestResult class

Returns:

the GType

asParent

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

contextIsEditable

public boolean contextIsEditable()

Check whether there is an editable element at the hit test position.

Checks whether HitTestResultContext.EDITABLE flag is present in the context flags.

Returns:

true if the hit test covers an editable element or false otherwise.

contextIsImage

public boolean contextIsImage()

Check whether there is an image element at the hit test position.

Checks whether HitTestResultContext.IMAGE flag is present in the context flags.

Returns:

true if the hit test covers an image element or false otherwise.

contextIsLink

public boolean contextIsLink()

Check whether there is a link element at the hit test position.

Checks whether HitTestResultContext.LINK flag is present in the context flags.

Returns:

true if the hit test covers a link element or false otherwise.

contextIsMedia

public boolean contextIsMedia()

Check whether there is a media element at the hit test position.

Checks whether HitTestResultContext.MEDIA flag is present in the context flags.

Returns:

true if the hit test covers a media element or false otherwise.

contextIsScrollbar

public boolean contextIsScrollbar()

Check whether there is a scrollbar at the hit test position.

Checks whether HitTestResultContext.SCROLLBAR flag is present in the context flags.

Returns:

true if the hit test covers a scrollbar or false otherwise.

contextIsSelection

public boolean contextIsSelection()

Check whether there is a selected element at the hit test position.

Checks whether HitTestResultContext.SELECTION flag is present in the context flags.

Returns:

true if the hit test covers a selected element or false otherwise.

getContext

public int getContext()

Gets the the context flags for the hit test result.

Returns:

a bitmask of WebKitHitTestResultContext flags

getImageUri

public String getImageUri()

Obtains the URI associated with the image element at the hit test position.

Returns:

the URI of the image element, or null if the hit test does not cover an image element.

getJsNode

public @Nullable Value getJsNode(@Nullable ScriptWorld world)

Get the JSCValue for the DOM node in world at the coordinates of the Hit Test.

Parameters:

world - a WebKitScriptWorld, or null to use the default

Returns:

a JSCValue for the DOM node, or null

Since:

2.40

getLinkLabel

public String getLinkLabel()

Obtains the label associated with the link element at the hit test position.

Returns:

the label of the link element, or null if the hit test does not cover a link element or the link element does not have a label.

getLinkTitle

public String getLinkTitle()

Obtains the title associated with the link element at the hit test position.

Returns:

the title of the link element, or null if the hit test does not cover a link element or the link element does not have a title.

getLinkUri

public String getLinkUri()

Obtains the URI associated with the link element at the hit test position.

Returns:

the URI of the link element, or null if the hit test does not cover a link element.

getMediaUri

public String getMediaUri()

Obtains the URI associated with the media element at the hit test position.

Returns:

the URI of the media element, or null if the hit test does not cover a media element.

builder

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

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

Returns:

the builder object