Class BoxLayout

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.LayoutManager

org.gnome.gtk.BoxLayout

All Implemented Interfaces:

Orientable, Proxy

@Generated("org.javagi.JavaGI")
public class BoxLayout
extends LayoutManager
implements Orientable

Arranges children in a single row or column.

Whether it is a row or column depends on the value of its Gtk.Orientable:orientation property. Within the other dimension all children all allocated the same size. The GtkBoxLayout will respect the Gtk.Widget:halign and Gtk.Widget:valign properties of each child widget.

If you want all children to be assigned the same size, you can use the Gtk.BoxLayout:homogeneous property.

If you want to specify the amount of space placed between each child, you can use the Gtk.BoxLayout:spacing property.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class LayoutManager

LayoutManager.LayoutManager$Impl, LayoutManager.LayoutManagerClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface Orientable

Orientable.Orientable$Impl, Orientable.OrientableIface

Constructor Summary

Constructors

Constructor	Description
BoxLayout()	Create a new BoxLayout.
BoxLayout(MemorySegment address)	Create a BoxLayout instance for the provided memory address.
BoxLayout(Orientation orientation)	Creates a new GtkBoxLayout.

Method Summary

Modifier and Type	Method	Description
protected BoxLayout	asParent()	Return this instance as if it were its parent type.
static BoxLayout.Builder<? extends BoxLayout.Builder>	builder()	A BoxLayout.Builder object constructs a BoxLayout with the specified properties.
int	getBaselineChild()	Gets the value set by gtk_box_layout_set_baseline_child().
BaselinePosition	getBaselinePosition()	Gets the value set by gtk_box_layout_set_baseline_position().
boolean	getHomogeneous()	Returns whether the layout is set to be homogeneous.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
int	getSpacing()	Returns the space that this BoxLayout puts between children.
static @Nullable Type	getType()	Get the GType of the BoxLayout class.
void	setBaselineChild(int child)	Sets the index of the child that determines the baseline in vertical layout.
void	setBaselinePosition(BaselinePosition position)	Sets the baseline position of a box layout.
void	setHomogeneous(boolean homogeneous)	Sets whether the box layout will allocate the same size to all children.
void	setSpacing(int spacing)	Sets how much spacing to put between children.

Methods inherited from class LayoutManager

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

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

Methods inherited from interface Orientable

getOrientation, setOrientation

Methods inherited from interface Proxy

handle

Constructor Details

BoxLayout

public BoxLayout(MemorySegment address)

Create a BoxLayout instance for the provided memory address.

Parameters:

address - the memory address of the native object

BoxLayout

public BoxLayout(Orientation orientation)

Creates a new GtkBoxLayout.

Parameters:

orientation - the orientation for the new layout

BoxLayout

public BoxLayout()

Create a new BoxLayout.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the BoxLayout class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

Returns:

the instance as if it were its parent type

getBaselineChild

public int getBaselineChild()

Gets the value set by gtk_box_layout_set_baseline_child().

Returns:

the index of the child that determines the baseline in vertical layout, or -1

Since:

4.12

getBaselinePosition

public BaselinePosition getBaselinePosition()

Gets the value set by gtk_box_layout_set_baseline_position().

Returns:

the baseline position

getHomogeneous

public boolean getHomogeneous()

Returns whether the layout is set to be homogeneous.

Returns:

true if the layout is homogeneous

getSpacing

public int getSpacing()

Returns the space that this BoxLayout puts between children.

Returns:

the spacing of the layout

setBaselineChild

public void setBaselineChild(int child)

Sets the index of the child that determines the baseline in vertical layout.

Parameters:

child - the child position, or -1

Since:

4.12

setBaselinePosition

public void setBaselinePosition(BaselinePosition position)

Sets the baseline position of a box layout.

The baseline position affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then the given position is used to allocate the baseline within the extra space available.

Parameters:

position - a GtkBaselinePosition

setHomogeneous

public void setHomogeneous(boolean homogeneous)

Sets whether the box layout will allocate the same size to all children.

Parameters:

homogeneous - true to set the box layout as homogeneous

setSpacing

public void setSpacing(int spacing)

Sets how much spacing to put between children.

Parameters:

spacing - the spacing to apply between children

builder

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

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

Returns:

the builder object