Package org.gnome.gtk

Class SortListModel<T extends GObject>

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.SortListModel<T>

All Implemented Interfaces:

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

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

A list model that sorts the elements of another model.

The elements are sorted according to a GtkSorter.

The model is a stable sort. If two items compare equal according to the sorter, the one that appears first in the original model will also appear first after sorting.

Note that if you change the sorter, the previous order will have no influence on the new order. If you want that, consider using a GtkMultiSorter and appending the previous sorter to it.

The model can be set up to do incremental sorting, so that sorting long lists doesn't block the UI. See setIncremental(boolean) for details.

GtkSortListModel is a generic model and because of that it cannot take advantage of any external knowledge when sorting. If you run into performance issues with GtkSortListModel, it is strongly recommended that you write your own sorting list model.

GtkSortListModel allows sorting the items into sections. It implements GtkSectionModel and when Gtk.SortListModel:section-sorter is set, it will sort all items with that sorter and items comparing equal with it will be put into the same section. The Gtk.SortListModel:sorter will then be used to sort items inside their sections.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SortListModel.Builder<B extends SortListModel.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	SortListModel.SortListModelClass<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.ListModel$Impl, ListModel.ListModelInterface

Nested classes/interfaces inherited from interface org.javagi.gio.ListModelJavaList

ListModelJavaList.SubList<E extends @Nullable GObject,List extends ListModelJavaList<E>>

Nested classes/interfaces inherited from interface org.gnome.gtk.SectionModel

SectionModel.SectionModel$Impl, SectionModel.SectionModelInterface, SectionModel.SectionsChangedCallback

Constructor Summary

Constructors

Constructor	Description
SortListModel()	Creates a new SortListModel.
SortListModel(MemorySegment address)	Create a SortListModel proxy instance for the provided memory address.
SortListModel(@Nullable ListModel model, @Nullable Sorter sorter)	Creates a new sort list model that uses the sorter to sort model.

Method Summary

Modifier and Type	Method	Description
protected SortListModel	asParent()	Returns this instance as if it were its parent type.
static SortListModel.Builder<? extends SortListModel.Builder>	builder()	A SortListModel.Builder object constructs a SortListModel with the specified properties.
boolean	getIncremental()	Returns whether incremental sorting is enabled.
@Nullable ListModel	getModel()	Gets the model currently sorted or null if none.
int	getPending()	Estimates progress of an ongoing sorting operation.
@Nullable Sorter	getSectionSorter()	Gets the section sorter that is used to sort items of this SortListModel into sections.
@Nullable Sorter	getSorter()	Gets the sorter that is used to sort self.
static @Nullable Type	getType()	Get the GType of the SortListModel class
void	setIncremental(boolean incremental)	Sets the sort model to do an incremental sort.
void	setModel(@Nullable ListModel model)	Sets the model to be sorted.
void	setSectionSorter(@Nullable Sorter sorter)	Sets a new section sorter on self.
void	setSorter(@Nullable Sorter sorter)	Sets a new sorter on self.

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

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 org.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 org.javagi.base.Proxy

handle

Methods inherited from interface org.gnome.gtk.SectionModel

emitSectionsChanged, getSection, onSectionsChanged, sectionsChanged

Constructor Details

SortListModel

public SortListModel(MemorySegment address)

Create a SortListModel proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

SortListModel

public SortListModel(@Nullable ListModel model,
 @Nullable Sorter sorter)

Creates a new sort list model that uses the sorter to sort model.

Parameters:

model - the model to sort

sorter - the GtkSorter to sort model with,

SortListModel

public SortListModel()

Creates a new SortListModel.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the SortListModel class

Returns:

the GType

asParent

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

getIncremental

public boolean getIncremental()

Returns whether incremental sorting is enabled.

See setIncremental(boolean).

Returns:

true if incremental sorting is enabled

getModel

public @Nullable ListModel getModel()

Gets the model currently sorted or null if none.

Returns:

The model that gets sorted

getPending

public int getPending()

Estimates progress of an ongoing sorting operation.

The estimate is the number of items that would still need to be sorted to finish the sorting operation if this was a linear algorithm. So this number is not related to how many items are already correctly sorted.

If you want to estimate the progress, you can use code like this:

pending = gtk_sort_list_model_get_pending (self);
 model = gtk_sort_list_model_get_model (self);
 progress = 1.0 - pending / (double) MAX (1, g_list_model_get_n_items (model));
 

If no sort operation is ongoing - in particular when Gtk.SortListModel:incremental is false - this function returns 0.

Returns:

a progress estimate of remaining items to sort

getSectionSorter

public @Nullable Sorter getSectionSorter()

Gets the section sorter that is used to sort items of this SortListModel into sections.

Returns:

the sorter of self

Since:

4.12

getSorter

public @Nullable Sorter getSorter()

Gets the sorter that is used to sort self.

Returns:

the sorter of self

setIncremental

public void setIncremental(boolean incremental)

Sets the sort model to do an incremental sort.

When incremental sorting is enabled, the GtkSortListModel will not do a complete sort immediately, but will instead queue an idle handler that incrementally sorts the items towards their correct position. This of course means that items do not instantly appear in the right place. It also means that the total sorting time is a lot slower.

When your filter blocks the UI while sorting, you might consider turning this on. Depending on your model and sorters, this may become interesting around 10,000 to 100,000 items.

By default, incremental sorting is disabled.

See getPending() for progress information about an ongoing incremental sorting operation.

Parameters:

incremental - true to sort incrementally

setModel

public void setModel(@Nullable ListModel model)

Sets the model to be sorted.

The model's item type must conform to the item type of self.

Parameters:

model - The model to be sorted

setSectionSorter

public void setSectionSorter(@Nullable Sorter sorter)

Sets a new section sorter on self.

Parameters:

sorter - the GtkSorter to sort model with

Since:

4.12

setSorter

public void setSorter(@Nullable Sorter sorter)

Sets a new sorter on self.

Parameters:

sorter - the GtkSorter to sort model with

builder

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

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

Returns:

the builder object