Package org.gnome.gtk

Class TreeListModel<T extends GObject>

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.TreeListModel<T>

All Implemented Interfaces:

Proxy, ListModelJavaList<T>, Iterable<T>, Collection<T>, List<T>, SequencedCollection<T>, ListModel<T>

@Generated("io.github.jwharm.JavaGI")
public class TreeListModel<T extends GObject>
extends GObject
implements ListModel<T>

GtkTreeListModel is a list model that can create child models on demand.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gio.ListModel

ListModel.ItemsChangedCallback, ListModel.ListModelImpl, ListModel.ListModelInterface

Constructor Summary

Constructors

Constructor	Description
TreeListModel(MemorySegment address)	Create a TreeListModel proxy instance for the provided memory address.
TreeListModel(ListModel root, boolean passthrough, boolean autoexpand, TreeListModelCreateModelFunc createFunc)	Creates a new empty GtkTreeListModel displaying root with all rows collapsed.

Method Summary

Modifier and Type	Method	Description
protected TreeListModel	asParent()	Returns this instance as if it were its parent type.
static TreeListModel.Builder<? extends TreeListModel.Builder>	builder()	A TreeListModel.Builder object constructs a TreeListModel with the specified properties.
boolean	getAutoexpand()	Gets whether the model is set to automatically expand new rows that get added.
TreeListRow	getChildRow(int position)	Gets the row item corresponding to the child at index position for this TreeListModel's root model.
ListModel	getModel()	Gets the root model that this TreeListModel was created with.
boolean	getPassthrough()	Gets whether the model is passing through original row items.
TreeListRow	getRow(int position)	Gets the row object for the given row.
static Type	getType()	Get the GType of the TreeListModel class
void	setAutoexpand(boolean autoexpand)	Sets whether the model should autoexpand.

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, 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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Methods inherited from interface org.gnome.gio.ListModel

emitItemsChanged, getItem, getItemType, getNItems, itemsChanged, onItemsChanged

Methods inherited from interface io.github.jwharm.javagi.gio.ListModelJavaList

add, add, addAll, addAll, clear, contains, containsAll, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

TreeListModel

public TreeListModel(MemorySegment address)

Create a TreeListModel proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

TreeListModel

public TreeListModel(ListModel root,
 boolean passthrough,
 boolean autoexpand,
 TreeListModelCreateModelFunc createFunc)

Creates a new empty GtkTreeListModel displaying root with all rows collapsed.

Parameters:

root - The GListModel to use as root

passthrough - true to pass through items from the models

autoexpand - true to set the autoexpand property and expand the root model

createFunc - function to call to create the GListModel for the children of an item

Method Details

getType

public static Type getType()

Get the GType of the TreeListModel class

Returns:

the GType

asParent

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

getAutoexpand

public boolean getAutoexpand()

Gets whether the model is set to automatically expand new rows that get added.

This can be either rows added by changes to the underlying models or via TreeListRow.setExpanded(boolean).

Returns:

true if the model is set to autoexpand

getChildRow

public TreeListRow getChildRow(int position)

Gets the row item corresponding to the child at index position for this TreeListModel's root model.

If position is greater than the number of children in the root model, null is returned.

Do not confuse this function with getRow(int).

Parameters:

position - position of the child to get

Returns:

the child in position

getModel

public ListModel getModel()

Gets the root model that this TreeListModel was created with.

Returns:

the root model

getPassthrough

public boolean getPassthrough()

Gets whether the model is passing through original row items.

If this function returns false, the GListModel functions for this TreeListModel return custom GtkTreeListRow objects. You need to call TreeListRow.getItem() on these objects to get the original item.

If true, the values of the child models are passed through in their original state. You then need to call getRow(int) to get the custom GtkTreeListRows.

Returns:

true if the model is passing through original row items

getRow

public TreeListRow getRow(int position)

Gets the row object for the given row.

If position is greater than the number of items in this TreeListModel, null is returned.

The row object can be used to expand and collapse rows as well as to inspect its position in the tree. See its documentation for details.

This row object is persistent and will refer to the current item as long as the row is present in this TreeListModel, independent of other rows being added or removed.

If this TreeListModel is set to not be passthrough, this function is equivalent to calling g_list_model_get_item().

Do not confuse this function with getChildRow(int).

Parameters:

position - the position of the row to fetch

Returns:

The row item

setAutoexpand

public void setAutoexpand(boolean autoexpand)

Sets whether the model should autoexpand.

If set to true, the model will recursively expand all rows that get added to the model. This can be either rows added by changes to the underlying models or via TreeListRow.setExpanded(boolean).

Parameters:

autoexpand - true to make the model autoexpand its rows

builder

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

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