Package org.gnome.gobject

Class BindingGroup

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.BindingGroup

All Implemented Interfaces:

Proxy

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

GBindingGroup can be used to bind multiple properties from an object collectively.

Use the various methods to bind properties from a single source object to multiple destination objects. Properties can be bound bidirectionally and are connected when the source object is set with setSource(org.gnome.gobject.GObject).

Since:

2.72

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected BindingGroup	asParent()	Returns this instance as if it were its parent type.
void	bind(String sourceProperty, GObject target, String targetProperty, Set<BindingFlags> flags)	Creates a binding between sourceProperty on the source object and targetProperty on target. Whenever the sourceProperty is changed the targetProperty is updated using the same value.
void	bind(String sourceProperty, GObject target, String targetProperty, BindingFlags... flags)	Creates a binding between sourceProperty on the source object and targetProperty on target. Whenever the sourceProperty is changed the targetProperty is updated using the same value.
void	bindFull(String sourceProperty, GObject target, String targetProperty, Set<BindingFlags> flags, @Nullable BindingTransformFunc transformTo, @Nullable BindingTransformFunc transformFrom)	Creates a binding between sourceProperty on the source object and targetProperty on target, allowing you to set the transformation functions to be used by the binding.
void	bindFull(String sourceProperty, GObject target, String targetProperty, BindingFlags flags, @Nullable BindingTransformFunc transformTo, @Nullable BindingTransformFunc transformFrom)	Creates a binding between sourceProperty on the source object and targetProperty on target, allowing you to set the transformation functions to be used by the binding.
void	bindWithClosures(String sourceProperty, GObject target, String targetProperty, Set<BindingFlags> flags, @Nullable Closure transformTo, @Nullable Closure transformFrom)	Creates a binding between sourceProperty on the source object and targetProperty on target, allowing you to set the transformation functions to be used by the binding.
void	bindWithClosures(String sourceProperty, GObject target, String targetProperty, BindingFlags flags, @Nullable Closure transformTo, @Nullable Closure transformFrom)	Creates a binding between sourceProperty on the source object and targetProperty on target, allowing you to set the transformation functions to be used by the binding.
static BindingGroup.Builder<? extends BindingGroup.Builder>	builder()	A BindingGroup.Builder object constructs a BindingGroup with the specified properties.
@Nullable GObject	dupSource()	Gets the source object used for binding properties.
static @Nullable Type	getType()	Get the GType of the BindingGroup class
void	setSource(@Nullable GObject source)	Sets source as the source object used for creating property bindings.

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

BindingGroup

public BindingGroup(MemorySegment address)

Create a BindingGroup proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

BindingGroup

public BindingGroup()

Creates a new BindingGroup.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the BindingGroup class

Returns:

the GType

asParent

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

bind

public void bind(String sourceProperty,
 GObject target,
 String targetProperty,
 Set<BindingFlags> flags)

Creates a binding between sourceProperty on the source object and targetProperty on target. Whenever the sourceProperty is changed the targetProperty is updated using the same value. The binding flag BindingFlags.SYNC_CREATE is automatically specified.

See g_object_bind_property() for more information.

Parameters:

sourceProperty - the property on the source to bind

target - the target GObject

targetProperty - the property on target to bind

flags - the flags used to create the GBinding

Since:

2.72

bind

public void bind(String sourceProperty,
 GObject target,
 String targetProperty,
 BindingFlags... flags)

Creates a binding between sourceProperty on the source object and targetProperty on target. Whenever the sourceProperty is changed the targetProperty is updated using the same value. The binding flag BindingFlags.SYNC_CREATE is automatically specified.

See g_object_bind_property() for more information.

Parameters:

sourceProperty - the property on the source to bind

target - the target GObject

targetProperty - the property on target to bind

flags - the flags used to create the GBinding

Since:

2.72

bindFull

public void bindFull(String sourceProperty,
 GObject target,
 String targetProperty,
 Set<BindingFlags> flags,
 @Nullable BindingTransformFunc transformTo,
 @Nullable BindingTransformFunc transformFrom)

Creates a binding between sourceProperty on the source object and targetProperty on target, allowing you to set the transformation functions to be used by the binding. The binding flag BindingFlags.SYNC_CREATE is automatically specified.

See g_object_bind_property_full() for more information.

Parameters:

sourceProperty - the property on the source to bind

target - the target GObject

targetProperty - the property on target to bind

flags - the flags used to create the GBinding

transformTo - the transformation function from the source object to the target, or null to use the default

transformFrom - the transformation function from the target to the source object, or null to use the default

Since:

2.72

bindFull

public void bindFull(String sourceProperty,
 GObject target,
 String targetProperty,
 BindingFlags flags,
 @Nullable BindingTransformFunc transformTo,
 @Nullable BindingTransformFunc transformFrom)

Creates a binding between sourceProperty on the source object and targetProperty on target, allowing you to set the transformation functions to be used by the binding. The binding flag BindingFlags.SYNC_CREATE is automatically specified.

See g_object_bind_property_full() for more information.

Parameters:

sourceProperty - the property on the source to bind

target - the target GObject

targetProperty - the property on target to bind

flags - the flags used to create the GBinding

transformTo - the transformation function from the source object to the target, or null to use the default

transformFrom - the transformation function from the target to the source object, or null to use the default

Since:

2.72

bindWithClosures

public void bindWithClosures(String sourceProperty,
 GObject target,
 String targetProperty,
 Set<BindingFlags> flags,
 @Nullable Closure transformTo,
 @Nullable Closure transformFrom)

Creates a binding between sourceProperty on the source object and targetProperty on target, allowing you to set the transformation functions to be used by the binding. The binding flag BindingFlags.SYNC_CREATE is automatically specified.

This function is the language bindings friendly version of g_binding_group_bind_property_full(), using GClosures instead of function pointers.

See g_object_bind_property_with_closures() for more information.

Parameters:

sourceProperty - the property on the source to bind

target - the target GObject

targetProperty - the property on target to bind

flags - the flags used to create the GBinding

transformTo - a GClosure wrapping the transformation function from the source object to the target, or null to use the default

transformFrom - a GClosure wrapping the transformation function from the target to the source object, or null to use the default

Since:

2.72

bindWithClosures

public void bindWithClosures(String sourceProperty,
 GObject target,
 String targetProperty,
 BindingFlags flags,
 @Nullable Closure transformTo,
 @Nullable Closure transformFrom)

Creates a binding between sourceProperty on the source object and targetProperty on target, allowing you to set the transformation functions to be used by the binding. The binding flag BindingFlags.SYNC_CREATE is automatically specified.

This function is the language bindings friendly version of g_binding_group_bind_property_full(), using GClosures instead of function pointers.

See g_object_bind_property_with_closures() for more information.

Parameters:

sourceProperty - the property on the source to bind

target - the target GObject

targetProperty - the property on target to bind

flags - the flags used to create the GBinding

transformTo - a GClosure wrapping the transformation function from the source object to the target, or null to use the default

transformFrom - a GClosure wrapping the transformation function from the target to the source object, or null to use the default

Since:

2.72

dupSource

public @Nullable GObject dupSource()

Gets the source object used for binding properties.

Returns:

a GObject or null.

Since:

2.72

setSource

public void setSource(@Nullable GObject source)

Sets source as the source object used for creating property bindings. If there is already a source object all bindings from it will be removed.

Note that all properties that have been bound must exist on source.

Parameters:

source - the source GObject, or null to clear it

Since:

2.72

builder

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

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

Returns:

the builder object