Package org.webkitgtk

Class BackForwardList

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.webkitgtk.BackForwardList

All Implemented Interfaces:

Proxy

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

List of visited pages.

WebKitBackForwardList maintains a list of visited pages used to navigate to recent pages. Items are inserted in the list in the order they are visited.

WebKitBackForwardList also maintains the notion of the current item (which is always at index 0), the preceding item (which is at index -1), and the following item (which is at index 1). Methods webkit_web_view_go_back() and webkit_web_view_go_forward() move the current item backward or forward by one. Method webkit_web_view_go_to_back_forward_list_item() sets the current item to the specified item. All other methods returning WebKitBackForwardListItem<!-- -->s do not change the value of the current item, they just return the requested item or items.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BackForwardList.BackForwardListClass
static class	BackForwardList.Builder<B extends BackForwardList.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	BackForwardList.ChangedCallback	Functional interface declaration of the ChangedCallback callback.

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected BackForwardList	asParent()	Returns this instance as if it were its parent type.
static BackForwardList.Builder<? extends BackForwardList.Builder>	builder()	A BackForwardList.Builder object constructs a BackForwardList with the specified properties.
void	emitChanged(@Nullable BackForwardListItem itemAdded, @Nullable MemorySegment itemsRemoved)	Emits the "changed" signal.
@Nullable BackForwardListItem	getBackItem()	Returns the item that precedes the current item.
List<BackForwardListItem>	getBackList()	Obtain the list of items preceding the current one.
List<BackForwardListItem>	getBackListWithLimit(int limit)	Obtain a list up to some number of items preceding the current one.
@Nullable BackForwardListItem	getCurrentItem()	Returns the current item in backForwardList.
@Nullable BackForwardListItem	getForwardItem()	Returns the item that follows the current item.
List<BackForwardListItem>	getForwardList()	Obtain the list of items following the current one.
List<BackForwardListItem>	getForwardListWithLimit(int limit)	Obtain a list up to some number of items following the current one.
int	getLength()	Obtain the amount of items in the list.
@Nullable BackForwardListItem	getNthItem(int index)	Returns the item at a given index relative to the current item.
static @Nullable Type	getType()	Get the GType of the BackForwardList class
SignalConnection<BackForwardList.ChangedCallback>	onChanged(BackForwardList.ChangedCallback handler)	This signal is emitted when backForwardList changes.

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

BackForwardList

public BackForwardList(MemorySegment address)

Create a BackForwardList proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

BackForwardList

public BackForwardList()

Creates a new BackForwardList.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the BackForwardList class

Returns:

the GType

asParent

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

getBackItem

public @Nullable BackForwardListItem getBackItem()

Returns the item that precedes the current item.

Returns:

the WebKitBackForwardListItem preceding the current item or null.

getBackList

public List<BackForwardListItem> getBackList()

Obtain the list of items preceding the current one.

Returns:

a GList of items preceding the current item.

getBackListWithLimit

public List<BackForwardListItem> getBackListWithLimit(int limit)

Obtain a list up to some number of items preceding the current one.

Parameters:

limit - the number of items to retrieve

Returns:

a GList of items preceding the current item limited by limit.

getCurrentItem

public @Nullable BackForwardListItem getCurrentItem()

Returns the current item in backForwardList.

Returns:

a WebKitBackForwardListItem or null if this BackForwardList is empty.

getForwardItem

public @Nullable BackForwardListItem getForwardItem()

Returns the item that follows the current item.

Returns:

the WebKitBackForwardListItem following the current item or null.

getForwardList

public List<BackForwardListItem> getForwardList()

Obtain the list of items following the current one.

Returns:

a GList of items following the current item.

getForwardListWithLimit

public List<BackForwardListItem> getForwardListWithLimit(int limit)

Obtain a list up to some number of items following the current one.

Parameters:

limit - the number of items to retrieve

Returns:

a GList of items following the current item limited by limit.

getLength

public int getLength()

Obtain the amount of items in the list.

Returns:

the length of backForwardList.

getNthItem

public @Nullable BackForwardListItem getNthItem(int index)

Returns the item at a given index relative to the current item.

Parameters:

index - the index of the item

Returns:

the WebKitBackForwardListItem located at the specified index relative to the current item or null.

onChanged

public SignalConnection<BackForwardList.ChangedCallback> onChanged(BackForwardList.ChangedCallback handler)

This signal is emitted when backForwardList changes. This happens when the current item is updated, a new item is added or one or more items are removed. Note that both itemAdded and itemsRemoved can null when only the current item is updated. Items are only removed when the list is cleared or the maximum items limit is reached.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• BackForwardList.ChangedCallback.run(org.webkitgtk.BackForwardListItem, java.lang.foreign.MemorySegment)

emitChanged

public void emitChanged(@Nullable BackForwardListItem itemAdded,
 @Nullable MemorySegment itemsRemoved)

Emits the "changed" signal. See onChanged(org.webkitgtk.BackForwardList.ChangedCallback).

builder

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

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

Returns:

the builder object