Package org.webkitgtk

Class NavigationAction

java.lang.Object

org.javagi.base.ProxyInstance

org.webkitgtk.NavigationAction

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class NavigationAction
extends ProxyInstance

Provides details about interaction resulting in a resource load.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
NavigationAction	copy()	Make a copy of navigation.
void	free()	Free the WebKitNavigationAction
@Nullable String	getFrameName()	Gets the this NavigationAction target frame name.
int	getModifiers()	Return the modifier keys.
int	getMouseButton()	Return the number of the mouse button that triggered the navigation.
NavigationType	getNavigationType()	Return the type of action that triggered the navigation.
URIRequest	getRequest()	Return the WebKitURIRequest associated with the navigation action.
static @Nullable Type	getType()	Get the GType of the NavigationAction class
boolean	isRedirect()	Returns whether the this NavigationAction was redirected.
boolean	isUserGesture()	Return whether the navigation was triggered by a user gesture like a mouse click.

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

NavigationAction

public NavigationAction(MemorySegment address)

Create a NavigationAction proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static @Nullable Type getType()

Get the GType of the NavigationAction class

Returns:

the GType

copy

public NavigationAction copy()

Make a copy of navigation.

Returns:

A copy of passed in WebKitNavigationAction

Since:

2.6

free

public void free()

Free the WebKitNavigationAction

Since:

2.6

getFrameName

public @Nullable String getFrameName()

Gets the this NavigationAction target frame name. For example if navigation was triggered by clicking a link with a target attribute equal to "_blank", this will return the value of that attribute. In all other cases this function will return null.

Returns:

The name of the new frame this navigation action targets or null

Since:

2.40

getModifiers

public int getModifiers()

Return the modifier keys.

Return a bitmask of GdkModifierType values describing the modifier keys that were in effect when the navigation was requested

Returns:

the modifier keys

Since:

2.6

getMouseButton

public int getMouseButton()

Return the number of the mouse button that triggered the navigation.

Return the number of the mouse button that triggered the navigation, or 0 if the navigation was not started by a mouse event.

Returns:

the mouse button number or 0

Since:

2.6

getNavigationType

public NavigationType getNavigationType()

Return the type of action that triggered the navigation.

Returns:

a WebKitNavigationType

Since:

2.6

getRequest

public URIRequest getRequest()

Return the WebKitURIRequest associated with the navigation action.

Modifications to the returned object are <emphasis>not</emphasis> taken into account when the request is sent over the network, and is intended only to aid in evaluating whether a navigation action should be taken or not. To modify requests before they are sent over the network the WebKitPage::send-request signal can be used instead.

Returns:

a WebKitURIRequest

Since:

2.6

isRedirect

public boolean isRedirect()

Returns whether the this NavigationAction was redirected.

Returns:

true if the original navigation was redirected, false otherwise.

Since:

2.20

isUserGesture

public boolean isUserGesture()

Return whether the navigation was triggered by a user gesture like a mouse click.

Returns:

whether navigation action is a user gesture

Since:

2.6