Package org.gnome.gtk

Class SingleSelection<T extends GObject>

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.SingleSelection<T>

All Implemented Interfaces:

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

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

A selection model that allows selecting a single item.

Note that the selection is persistent -- if the selected item is removed and re-added in the same Gio.ListModel::items-changed emission, it stays selected. In particular, this means that changing the sort order of an underlying sort model will preserve the selection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SingleSelection.Builder<B extends SingleSelection.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	SingleSelection.SingleSelectionClass<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

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

SelectionModel.SelectionChangedCallback, SelectionModel.SelectionModel$Impl, SelectionModel.SelectionModelInterface

Constructor Summary

Constructors

Constructor	Description
SingleSelection()	Creates a new SingleSelection.
SingleSelection(MemorySegment address)	Create a SingleSelection proxy instance for the provided memory address.
SingleSelection(@Nullable ListModel model)	Creates a new selection to handle model.

Method Summary

Modifier and Type	Method	Description
protected SingleSelection	asParent()	Returns this instance as if it were its parent type.
static SingleSelection.Builder<? extends SingleSelection.Builder>	builder()	A SingleSelection.Builder object constructs a SingleSelection with the specified properties.
boolean	getAutoselect()	Checks if autoselect has been enabled or disabled via gtk_single_selection_set_autoselect().
boolean	getCanUnselect()	If true, gtk_selection_model_unselect_item() is supported and allows unselecting the selected item.
@Nullable ListModel	getModel()	Gets the model that this SingleSelection is wrapping.
int	getSelected()	Gets the position of the selected item.
T	getSelectedItem()	Gets the selected item.
static @Nullable Type	getType()	Get the GType of the SingleSelection class
void	setAutoselect(boolean autoselect)	Enables or disables autoselect.
void	setCanUnselect(boolean canUnselect)	If true, unselecting the current item via gtk_selection_model_unselect_item() is supported.
void	setModel(@Nullable ListModel model)	Sets the model that this SingleSelection should wrap.
void	setSelected(int position)	Selects the item at the given position.

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

Methods inherited from interface org.gnome.gtk.SelectionModel

emitSelectionChanged, getSelection, getSelectionInRange, isSelected, onSelectionChanged, selectAll, selectionChanged, selectItem, selectRange, setSelection, unselectAll, unselectItem, unselectRange

Constructor Details

SingleSelection

public SingleSelection(MemorySegment address)

Create a SingleSelection proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

SingleSelection

public SingleSelection(@Nullable ListModel model)

Creates a new selection to handle model.

Parameters:

model - the GListModel to manage

SingleSelection

public SingleSelection()

Creates a new SingleSelection.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the SingleSelection class

Returns:

the GType

asParent

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

getAutoselect

public boolean getAutoselect()

Checks if autoselect has been enabled or disabled via gtk_single_selection_set_autoselect().

Returns:

true if autoselect is enabled

getCanUnselect

public boolean getCanUnselect()

If true, gtk_selection_model_unselect_item() is supported and allows unselecting the selected item.

Returns:

true to support unselecting

getModel

public @Nullable ListModel getModel()

Gets the model that this SingleSelection is wrapping.

Returns:

The model being wrapped

getSelected

public int getSelected()

Gets the position of the selected item.

If no item is selected, GTK_INVALID_LIST_POSITION is returned.

Returns:

The position of the selected item

getSelectedItem

public T getSelectedItem()

Gets the selected item.

If no item is selected, null is returned.

Returns:

The selected item

setAutoselect

public void setAutoselect(boolean autoselect)

Enables or disables autoselect.

If autoselect is true, this SingleSelection will enforce that an item is always selected. It will select a new item when the currently selected item is deleted and it will disallow unselecting the current item.

Parameters:

autoselect - true to always select an item

setCanUnselect

public void setCanUnselect(boolean canUnselect)

If true, unselecting the current item via gtk_selection_model_unselect_item() is supported.

Note that setting Gtk.SingleSelection:autoselect will cause unselecting to not work, so it practically makes no sense to set both at the same time.

Parameters:

canUnselect - true to allow unselecting

setModel

public void setModel(@Nullable ListModel model)

Sets the model that this SingleSelection should wrap.

If model is null, this SingleSelection will be empty.

Parameters:

model - A GListModel to wrap

setSelected

public void setSelected(int position)

Selects the item at the given position.

If the list does not have an item at position or GTK_INVALID_LIST_POSITION is given, the behavior depends on the value of the Gtk.SingleSelection:autoselect property: If it is set, no change will occur and the old item will stay selected. If it is unset, the selection will be unset and no item will be selected. This also applies if Gtk.SingleSelection:can-unselect is set to false.

Parameters:

position - the item to select or GTK_INVALID_LIST_POSITION

builder

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

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

Returns:

the builder object