Class StringSorter

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.Sorter

org.gnome.gtk.StringSorter

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public class StringSorter
extends Sorter

Sorts items by comparing strings.

To obtain the strings to compare, this sorter evaluates a Expression.

It does the comparison in a linguistically correct way using the current locale by normalizing Unicode strings and possibly case-folding them before performing the comparison.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Sorter

Sorter.ChangedCallback, Sorter.SorterClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
StringSorter()	Create a new StringSorter.
StringSorter(MemorySegment address)	Create a StringSorter instance for the provided memory address.
StringSorter(@Nullable Expression expression)	Creates a new string sorter that compares items using the given expression.

Method Summary

Modifier and Type	Method	Description
protected StringSorter	asParent()	Return this instance as if it were its parent type.
static StringSorter.Builder<? extends StringSorter.Builder>	builder()	A StringSorter.Builder object constructs a StringSorter with the specified properties.
Collation	getCollation()	Gets which collation method the sorter uses.
@Nullable Expression	getExpression()	Gets the expression that is evaluated to obtain strings from items.
boolean	getIgnoreCase()	Gets whether the sorter ignores case differences.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the StringSorter class.
void	setCollation(Collation collation)	Sets the collation method to use for sorting.
void	setExpression(@Nullable Expression expression)	Sets the expression that is evaluated to obtain strings from items.
void	setIgnoreCase(boolean ignoreCase)	Sets whether the sorter will ignore case differences.

Methods inherited from class Sorter

changed, compare, emitChanged, getOrder, onChanged

Methods inherited from class 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, 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 TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StringSorter

public StringSorter(MemorySegment address)

Create a StringSorter instance for the provided memory address.

Parameters:

address - the memory address of the native object

StringSorter

public StringSorter(@Nullable Expression expression)

Creates a new string sorter that compares items using the given expression.

Unless an expression is set on it, this sorter will always compare items as invalid.

Parameters:

expression - The expression to evaluate

StringSorter

public StringSorter()

Create a new StringSorter.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the StringSorter class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected StringSorter asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class Sorter

Returns:

the instance as if it were its parent type

getCollation

public Collation getCollation()

Gets which collation method the sorter uses.

Returns:

The collation method

Since:

4.10

getExpression

public @Nullable Expression getExpression()

Gets the expression that is evaluated to obtain strings from items.

Returns:

a GtkExpression

getIgnoreCase

public boolean getIgnoreCase()

Gets whether the sorter ignores case differences.

Returns:

true if this StringSorter is ignoring case differences

setCollation

public void setCollation(Collation collation)

Sets the collation method to use for sorting.

Parameters:

collation - the collation method

Since:

4.10

setExpression

public void setExpression(@Nullable Expression expression)

Sets the expression that is evaluated to obtain strings from items.

The expression must have the type G_TYPE_STRING.

Parameters:

expression - a GtkExpression

setIgnoreCase

public void setIgnoreCase(boolean ignoreCase)

Sets whether the sorter will ignore case differences.

Parameters:

ignoreCase - true to ignore case differences

builder

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

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

Returns:

the builder object