Package org.gnome.adw

Class NavigationSplitView.Builder<B extends NavigationSplitView.Builder<B>>

java.lang.Object

io.github.jwharm.javagi.gobject.Builder<B>

org.gnome.gobject.GObject.Builder<B>

org.gnome.gobject.InitiallyUnowned.Builder<B>

org.gnome.gtk.Widget.Builder<B>

org.gnome.adw.NavigationSplitView.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface, Accessible.Builder<B>

Enclosing class:

NavigationSplitView

public static class NavigationSplitView.Builder<B extends NavigationSplitView.Builder<B>>
extends Widget.Builder<B>
implements Accessible.Builder<B>

Inner class implementing a builder pattern to construct a GObject with properties.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Default constructor for a Builder object.

Method Summary

Modifier and Type	Method	Description
NavigationSplitView	build()	Finish building the NavigationSplitView object.
B	setCollapsed(boolean collapsed)	Whether the split view is collapsed.
B	setContent(NavigationPage content)	The content widget.
B	setMaxSidebarWidth(double maxSidebarWidth)	The maximum sidebar width.
B	setMinSidebarWidth(double minSidebarWidth)	The minimum sidebar width.
B	setShowContent(boolean showContent)	Determines the visible page when collapsed.
B	setSidebar(NavigationPage sidebar)	The sidebar widget.
B	setSidebarWidthFraction(double sidebarWidthFraction)	The preferred sidebar width as a fraction of the total width.
B	setSidebarWidthUnit(LengthUnit sidebarWidthUnit)	The length unit for minimum and maximum sidebar widths.

Methods inherited from class org.gnome.gtk.Widget.Builder

onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, setCanFocus, setCanTarget, setCssClasses, setCssName, setCursor, setFocusable, setFocusOnClick, setHalign, setHasTooltip, setHeightRequest, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setReceivesDefault, setSensitive, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, setWidthRequest

Methods inherited from class org.gnome.gobject.GObject.Builder

onNotify

Methods inherited from class io.github.jwharm.javagi.gobject.Builder

addBuilderProperty, connect, connect, connectSignals, getArena, getNames, getValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gnome.gtk.Accessible.Builder

setAccessibleRole

Methods inherited from interface io.github.jwharm.javagi.gobject.BuilderInterface

addBuilderProperty, connect, connect, getArena

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public NavigationSplitView build()

Finish building the NavigationSplitView object. This will call GObject.withProperties(org.gnome.glib.Type, java.lang.String[], org.gnome.gobject.Value[]) to create a new GObject instance, which is then cast to NavigationSplitView.

Overrides:

build in class Widget.Builder<B extends NavigationSplitView.Builder<B>>

Returns:

a new instance of NavigationSplitView with the properties that were set in the Builder object.

setCollapsed

public B setCollapsed(boolean collapsed)

Whether the split view is collapsed.

When collapsed, the children are put inside an NavigationView, otherwise they are displayed side by side.

The NavigationSplitView:show-content controls which child is visible while collapsed.

Parameters:

collapsed - the value for the collapsed property

Returns:

the Builder instance is returned, to allow method chaining

setContent

public B setContent(NavigationPage content)

The content widget.

Parameters:

content - the value for the content property

Returns:

the Builder instance is returned, to allow method chaining

setMaxSidebarWidth

public B setMaxSidebarWidth(double maxSidebarWidth)

The maximum sidebar width.

Maximum width is affected by NavigationSplitView:sidebar-width-unit.

The sidebar widget can still be allocated with larger width if its own minimum width exceeds it.

Parameters:

maxSidebarWidth - the value for the max-sidebar-width property

Returns:

the Builder instance is returned, to allow method chaining

setMinSidebarWidth

public B setMinSidebarWidth(double minSidebarWidth)

The minimum sidebar width.

Minimum width is affected by NavigationSplitView:sidebar-width-unit.

The sidebar widget can still be allocated with larger width if its own minimum width exceeds it.

Parameters:

minSidebarWidth - the value for the min-sidebar-width property

Returns:

the Builder instance is returned, to allow method chaining

setShowContent

public B setShowContent(boolean showContent)

Determines the visible page when collapsed.

If set to TRUE, the content widget will be the visible page when NavigationSplitView:collapsed is TRUE; otherwise the sidebar widget will be visible.

If the split view is already collapsed, the visible page changes immediately.

Parameters:

showContent - the value for the show-content property

Returns:

the Builder instance is returned, to allow method chaining

setSidebar

public B setSidebar(NavigationPage sidebar)

The sidebar widget.

Parameters:

sidebar - the value for the sidebar property

Returns:

the Builder instance is returned, to allow method chaining

setSidebarWidthFraction

public B setSidebarWidthFraction(double sidebarWidthFraction)

The preferred sidebar width as a fraction of the total width.

The preferred width is additionally limited by NavigationSplitView:min-sidebar-width and NavigationSplitView:max-sidebar-width.

The sidebar widget can be allocated with larger width if its own minimum width exceeds the preferred width.

Parameters:

sidebarWidthFraction - the value for the sidebar-width-fraction property

Returns:

the Builder instance is returned, to allow method chaining

setSidebarWidthUnit

public B setSidebarWidthUnit(LengthUnit sidebarWidthUnit)

The length unit for minimum and maximum sidebar widths.

See NavigationSplitView:min-sidebar-width and NavigationSplitView:max-sidebar-width.

Parameters:

sidebarWidthUnit - the value for the sidebar-width-unit property

Returns:

the Builder instance is returned, to allow method chaining