Package org.gnome.webkit

Class HitTestResult

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.webkit.HitTestResult

All Implemented Interfaces:

Proxy

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

Result of a Hit Test.

A Hit Test is an operation to get context information about a given point in a WebKitWebView. WebKitHitTestResult represents the result of a Hit Test. It provides context information about what is at the coordinates of the Hit Test, such as if there's a link, an image or a media.

You can get the context of the HitTestResult with webkit_hit_test_result_get_context() that returns a bitmask of WebKitHitTestResultContext flags. You can also use webkit_hit_test_result_context_is_link(), webkit_hit_test_result_context_is_image() and webkit_hit_test_result_context_is_media() to determine whether there's a link, image or a media element at the coordinates of the Hit Test. Note that it's possible that several WebKitHitTestResultContext flags are active at the same time, for example if there's a link containing an image.

When the mouse is moved over a WebKitWebView a Hit Test is performed for the mouse coordinates and WebKitWebView::mouse-target-changed signal is emitted with a WebKitHitTestResult.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
HitTestResult(MemorySegment address)	Create a HitTestResult proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected HitTestResult	asParent()	Returns this instance as if it were its parent type.
static HitTestResult.Builder<? extends HitTestResult.Builder>	builder()	A HitTestResult.Builder object constructs a HitTestResult with the specified properties.
boolean	contextIsEditable()	Gets whether HitTestResultContext.EDITABLE flag is present in WebKitHitTestResult:context.
boolean	contextIsImage()	Gets whether HitTestResultContext.IMAGE flag is present in WebKitHitTestResult:context.
boolean	contextIsLink()	Gets whether HitTestResultContext.LINK flag is present in WebKitHitTestResult:context.
boolean	contextIsMedia()	Gets whether HitTestResultContext.MEDIA flag is present in WebKitHitTestResult:context.
boolean	contextIsScrollbar()	Gets whether HitTestResultContext.SCROLLBAR flag is present in WebKitHitTestResult:context.
boolean	contextIsSelection()	Gets whether HitTestResultContext.SELECTION flag is present in WebKitHitTestResult:context.
int	getContext()	Gets the value of the WebKitHitTestResult:context property.
String	getImageUri()	Gets the value of the WebKitHitTestResult:image-uri property.
String	getLinkLabel()	Gets the value of the WebKitHitTestResult:link-label property.
String	getLinkTitle()	Gets the value of the WebKitHitTestResult:link-title property.
String	getLinkUri()	Gets the value of the WebKitHitTestResult:link-uri property.
String	getMediaUri()	Gets the value of the WebKitHitTestResult:media-uri property.
static Type	getType()	Get the GType of the HitTestResult 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, 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

HitTestResult

public HitTestResult(MemorySegment address)

Create a HitTestResult proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the HitTestResult class

Returns:

the GType

asParent

protected HitTestResult 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()

Gets whether HitTestResultContext.EDITABLE flag is present in WebKitHitTestResult:context.

Returns:

true if there's an editable element at the coordinates of the this HitTestResult, or false otherwise

contextIsImage

public boolean contextIsImage()

Gets whether HitTestResultContext.IMAGE flag is present in WebKitHitTestResult:context.

Returns:

true if there's an image element in the coordinates of the Hit Test, or false otherwise

contextIsLink

public boolean contextIsLink()

Gets whether HitTestResultContext.LINK flag is present in WebKitHitTestResult:context.

Returns:

true if there's a link element in the coordinates of the Hit Test, or false otherwise

contextIsMedia

public boolean contextIsMedia()

Gets whether HitTestResultContext.MEDIA flag is present in WebKitHitTestResult:context.

Returns:

true if there's a media element in the coordinates of the Hit Test, or false otherwise

contextIsScrollbar

public boolean contextIsScrollbar()

Gets whether HitTestResultContext.SCROLLBAR flag is present in WebKitHitTestResult:context.

Returns:

true if there's a scrollbar element at the coordinates of the this HitTestResult, or false otherwise

contextIsSelection

public boolean contextIsSelection()

Gets whether HitTestResultContext.SELECTION flag is present in WebKitHitTestResult:context.

Returns:

true if there's a selected element at the coordinates of the this HitTestResult, or false otherwise

getContext

public int getContext()

Gets the value of the WebKitHitTestResult:context property.

Returns:

a bitmask of WebKitHitTestResultContext flags

getImageUri

public String getImageUri()

Gets the value of the WebKitHitTestResult:image-uri property.

Returns:

the URI of the image element in the coordinates of the Hit Test, or null if there isn't an image element in this HitTestResult context

getLinkLabel

public String getLinkLabel()

Gets the value of the WebKitHitTestResult:link-label property.

Returns:

the label of the link element in the coordinates of the Hit Test, or null if there isn't a link element in this HitTestResult context or the link element doesn't have a label

getLinkTitle

public String getLinkTitle()

Gets the value of the WebKitHitTestResult:link-title property.

Returns:

the title of the link element in the coordinates of the Hit Test, or null if there isn't a link element in this HitTestResult context or the link element doesn't have a title

getLinkUri

public String getLinkUri()

Gets the value of the WebKitHitTestResult:link-uri property.

Returns:

the URI of the link element in the coordinates of the Hit Test, or null if there isn't a link element in this HitTestResult context

getMediaUri

public String getMediaUri()

Gets the value of the WebKitHitTestResult:media-uri property.

Returns:

the URI of the media element in the coordinates of the Hit Test, or null if there isn't a media element in this HitTestResult context

builder

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

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