Package org.gnome.adw

Class Breakpoint

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.adw.Breakpoint

All Implemented Interfaces:

Buildable, Proxy

@Generated("io.github.jwharm.JavaGI")
public final class Breakpoint
extends GObject
implements Buildable

Describes a breakpoint for Window or Dialog.

Breakpoints are used to create adaptive UI, allowing to change the layout depending on available size.

Breakpoint is a size threshold, specified by its condition, as well as one or more setters.

Each setter has a target object, a property and a value. When a breakpoint is applied, each setter sets the target property on their target object to the specified value, and reset it back to the original value when it's unapplied.

For more complicated scenarios, Breakpoint::apply and Breakpoint::unapply can be used instead.

Breakpoints can be used within Window, ApplicationWindow, Dialog or BreakpointBin.

AdwBreakpoint as GtkBuildable:
AdwBreakpoint supports specifying its condition via the <condition> element. The contents of the element must be a string in a format accepted by BreakpointCondition.parse(java.lang.String).

It also supports adding setters via the <setter> element. Each <setter> element must have the object attribute specifying the target object, and the property attribute specifying the property name. The contents of the element are used as the setter value.

For G_TYPE_OBJECT and G_TYPE_BOXED derived properties, empty contents are treated as NULL.

Setter values can be translated with the usual translatable, context and comments attributes.

Example of an AdwBreakpoint UI definition:

<object class="AdwBreakpoint">
   <condition>max-width: 400px</condition>
   <setter object="button" property="visible">True</setter>
   <setter object="box" property="orientation">vertical</setter>
   <setter object="page" property="title" translatable="yes">Example</setter>
 </object>
 

Since:

1.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Breakpoint.ApplyCallback	Functional interface declaration of the ApplyCallback callback.
static class	Breakpoint.BreakpointClass
static class	Breakpoint.Builder<B extends Breakpoint.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	Breakpoint.UnapplyCallback	Functional interface declaration of the UnapplyCallback callback.

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

GObject.NotifyCallback, GObject.ObjectClass

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

Buildable.Buildable$Impl, Buildable.BuildableIface

Constructor Summary

Constructors

Constructor	Description
Breakpoint()	Creates a new Breakpoint.
Breakpoint(MemorySegment address)	Create a Breakpoint proxy instance for the provided memory address.
Breakpoint(BreakpointCondition condition)	Creates a new AdwBreakpoint with condition.

Method Summary

Modifier and Type	Method	Description
void	addSetter(GObject object, String property, @Nullable Value value)	Adds a setter to self.
void	addSetters(@Nullable GObject @Nullable [] objects, @Nullable String @Nullable [] names, @Nullable Value @Nullable [] values)	Adds nSetters setters to self.
protected Breakpoint	asParent()	Returns this instance as if it were its parent type.
static Breakpoint.Builder<? extends Breakpoint.Builder>	builder()	A Breakpoint.Builder object constructs a Breakpoint with the specified properties.
void	emitApply()	Emits the "apply" signal.
void	emitUnapply()	Emits the "unapply" signal.
@Nullable BreakpointCondition	getCondition()	Gets the condition for self.
static @Nullable Type	getType()	Get the GType of the Breakpoint class
SignalConnection<Breakpoint.ApplyCallback>	onApply(Breakpoint.ApplyCallback handler)	Emitted when the breakpoint is applied.
SignalConnection<Breakpoint.UnapplyCallback>	onUnapply(Breakpoint.UnapplyCallback handler)	Emitted when the breakpoint is unapplied.
void	setCondition(@Nullable BreakpointCondition condition)	Sets the condition for 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 org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

Breakpoint

public Breakpoint(MemorySegment address)

Create a Breakpoint proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Breakpoint

public Breakpoint(BreakpointCondition condition)

Creates a new AdwBreakpoint with condition.

Parameters:

condition - the condition

Since:

1.4

Breakpoint

public Breakpoint()

Creates a new Breakpoint.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Breakpoint class

Returns:

the GType

asParent

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

addSetter

public void addSetter(GObject object,
 String property,
 @Nullable Value value)

Adds a setter to self.

The setter will automatically set property on object to value when applying the breakpoint, and set it back to its original value upon unapplying it.

Note Setting properties to their original values does not work for properties that have irreversible side effects. For example, changing [property@Gtk.Button:label] while [property@Gtk.Button:icon-name] is set will reset the icon. However, resetting the label will not set icon-name to its original value. Use the [signal@Breakpoint::apply] and [signal@Breakpoint::unapply] signals for those properties instead, as follows: ``c static void breakpoint_apply_cb (MyWidget *self) { gtk_button_set_icon_name (self->button, "go-previous-symbolic"); } static void breakpoint_apply_cb (MyWidget *self) { gtk_button_set_label (self->button, _("_Back")); } // ... g_signal_connect_swapped (breakpoint, "apply", G_CALLBACK (breakpoint_apply_cb), self); g_signal_connect_swapped (breakpoint, "unapply", G_CALLBACK (breakpoint_unapply_cb), self); ``

Parameters:

object - the target object

property - the target property

value - the value to set

Since:

1.4

addSetters

public void addSetters(@Nullable GObject @Nullable [] objects,
 @Nullable String @Nullable [] names,
 @Nullable Value @Nullable [] values)

Adds nSetters setters to self.

This is a convenience function for adding multiple setters at once.

See addSetter(org.gnome.gobject.GObject, java.lang.String, org.gnome.gobject.Value).

This function is meant to be used by language bindings.

Parameters:

objects - setter target object

names - setter target properties

values - setter values

Since:

1.4

getCondition

public @Nullable BreakpointCondition getCondition()

Gets the condition for self.

Returns:

the condition

Since:

1.4

setCondition

public void setCondition(@Nullable BreakpointCondition condition)

Sets the condition for self.

Parameters:

condition - the new condition

Since:

1.4

onApply

public SignalConnection<Breakpoint.ApplyCallback> onApply(Breakpoint.ApplyCallback handler)

Emitted when the breakpoint is applied.

This signal is emitted after the setters have been applied.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

1.4

See Also:

• Breakpoint.ApplyCallback.run()

emitApply

public void emitApply()

Emits the "apply" signal. See onApply(org.gnome.adw.Breakpoint.ApplyCallback).

onUnapply

public SignalConnection<Breakpoint.UnapplyCallback> onUnapply(Breakpoint.UnapplyCallback handler)

Emitted when the breakpoint is unapplied.

This signal is emitted before resetting the setter values.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

1.4

See Also:

• Breakpoint.UnapplyCallback.run()

emitUnapply

public void emitUnapply()

Emits the "unapply" signal. See onUnapply(org.gnome.adw.Breakpoint.UnapplyCallback).

builder

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

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

Returns:

the builder object