Package org.gnome.adw

Class ClampLayout

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.LayoutManager

org.gnome.adw.ClampLayout

All Implemented Interfaces:

Orientable, Proxy

@Generated("io.github.jwharm.JavaGI")
public final class ClampLayout
extends LayoutManager
implements Orientable

A layout manager constraining its children to a given size.

AdwClampLayout constraints the size of the widgets it contains to a given maximum size. It will constrain the width if it is horizontal, or the height if it is vertical. The expansion of the children from their minimum to their maximum size is eased out for a smooth transition.

If a child requires more than the requested maximum size, it will be allocated the minimum size it can fit in instead.

AdwClampLayout can scale with the text scale factor, use the ClampLayout:unit property to enable that behavior.

See also: Clamp, ClampScrollable.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.gnome.gtk.LayoutManager

LayoutManager.LayoutManager$Impl, LayoutManager.LayoutManagerClass

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

GObject.NotifyCallback, GObject.ObjectClass

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

Orientable.Orientable$Impl, Orientable.OrientableIface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected ClampLayout	asParent()	Returns this instance as if it were its parent type.
static ClampLayout.Builder<? extends ClampLayout.Builder>	builder()	A ClampLayout.Builder object constructs a ClampLayout with the specified properties.
int	getMaximumSize()	Gets the maximum size allocated to the children.
int	getTighteningThreshold()	Gets the size above which the children are clamped.
static @Nullable Type	getType()	Get the GType of the ClampLayout class
LengthUnit	getUnit()	Gets the length unit for maximum size and tightening threshold.
void	setMaximumSize(int maximumSize)	Sets the maximum size allocated to the children.
void	setTighteningThreshold(int tighteningThreshold)	Sets the size above which the children are clamped.
void	setUnit(LengthUnit unit)	Sets the length unit for maximum size and tightening threshold.

Methods inherited from class org.gnome.gtk.LayoutManager

allocate, createLayoutChild, getLayoutChild, getMemoryLayout, getRequestMode, getRequestMode, getWidget, layoutChanged, measure, root, unroot

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, 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.Orientable

getOrientation, setOrientation

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

ClampLayout

public ClampLayout(MemorySegment address)

Create a ClampLayout proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ClampLayout

public ClampLayout()

Creates a new ClampLayout.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ClampLayout class

Returns:

the GType

asParent

protected ClampLayout 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 LayoutManager

getMaximumSize

public int getMaximumSize()

Gets the maximum size allocated to the children.

Returns:

the maximum size to allocate to the children

getTighteningThreshold

public int getTighteningThreshold()

Gets the size above which the children are clamped.

Returns:

the size above which the children are clamped

getUnit

public LengthUnit getUnit()

Gets the length unit for maximum size and tightening threshold.

Returns:

the length unit

Since:

1.4

setMaximumSize

public void setMaximumSize(int maximumSize)

Sets the maximum size allocated to the children.

It is the width if the layout is horizontal, or the height if it is vertical.

Parameters:

maximumSize - the maximum size

setTighteningThreshold

public void setTighteningThreshold(int tighteningThreshold)

Sets the size above which the children are clamped.

Starting from this size, the layout will tighten its grip on the children, slowly allocating less and less of the available size up to the maximum allocated size. Below that threshold and below the maximum size, the children will be allocated all the available size.

If the threshold is greater than the maximum size to allocate to the children, they will be allocated the whole size up to the maximum. If the threshold is lower than the minimum size to allocate to the children, that size will be used as the tightening threshold.

Effectively, tightening the grip on a child before it reaches its maximum size makes transitions to and from the maximum size smoother when resizing.

Parameters:

tighteningThreshold - the tightening threshold

setUnit

public void setUnit(LengthUnit unit)

Sets the length unit for maximum size and tightening threshold.

Allows the sizes to vary depending on the text scale factor.

Parameters:

unit - the length unit

Since:

1.4

builder

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

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

Returns:

the builder object