Package org.gnome.adw

Class HeaderBar.Builder<B extends HeaderBar.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.HeaderBar.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface, Accessible.Builder<B>

Enclosing class:

HeaderBar

public static class HeaderBar.Builder<B extends HeaderBar.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
HeaderBar	build()	Finish building the HeaderBar object.
B	setCenteringPolicy(CenteringPolicy centeringPolicy)	The policy for aligning the center widget.
B	setDecorationLayout(String decorationLayout)	The decoration layout for buttons.
B	setShowBackButton(boolean showBackButton)	Whether the header bar can show the back button.
B	setShowEndTitleButtons(boolean showEndTitleButtons)	Whether to show title buttons at the end of the header bar.
B	setShowStartTitleButtons(boolean showStartTitleButtons)	Whether to show title buttons at the start of the header bar.
B	setShowTitle(boolean showTitle)	Whether the title widget should be shown.
B	setTitleWidget(Widget titleWidget)	The title widget to display.

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 HeaderBar build()

Finish building the HeaderBar 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 HeaderBar.

Overrides:

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

Returns:

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

setCenteringPolicy

public B setCenteringPolicy(CenteringPolicy centeringPolicy)

The policy for aligning the center widget.

Parameters:

centeringPolicy - the value for the centering-policy property

Returns:

the Builder instance is returned, to allow method chaining

setDecorationLayout

public B setDecorationLayout(String decorationLayout)

The decoration layout for buttons.

If this property is not set, the Gtk.Settings:gtk-decoration-layout setting is used.

The format of the string is button names, separated by commas. A colon separates the buttons that should appear at the start from those at the end. Recognized button names are minimize, maximize, close and icon (the window icon).

For example, “icon:minimize,maximize,close” specifies an icon at the start, and minimize, maximize and close buttons at the end.

Parameters:

decorationLayout - the value for the decoration-layout property

Returns:

the Builder instance is returned, to allow method chaining

setShowBackButton

public B setShowBackButton(boolean showBackButton)

Whether the header bar can show the back button.

The back button will never be shown unless the header bar is placed inside an NavigationView. Usually, there is no reason to set this to FALSE.

Parameters:

showBackButton - the value for the show-back-button property

Returns:

the Builder instance is returned, to allow method chaining

setShowEndTitleButtons

public B setShowEndTitleButtons(boolean showEndTitleButtons)

Whether to show title buttons at the end of the header bar.

See HeaderBar:show-start-title-buttons for the other side.

Which buttons are actually shown and where is determined by the HeaderBar:decoration-layout property, and by the state of the window (e.g. a close button will not be shown if the window can't be closed).

Parameters:

showEndTitleButtons - the value for the show-end-title-buttons property

Returns:

the Builder instance is returned, to allow method chaining

setShowStartTitleButtons

public B setShowStartTitleButtons(boolean showStartTitleButtons)

Whether to show title buttons at the start of the header bar.

See HeaderBar:show-end-title-buttons for the other side.

Which buttons are actually shown and where is determined by the HeaderBar:decoration-layout property, and by the state of the window (e.g. a close button will not be shown if the window can't be closed).

Parameters:

showStartTitleButtons - the value for the show-start-title-buttons property

Returns:

the Builder instance is returned, to allow method chaining

setShowTitle

public B setShowTitle(boolean showTitle)

Whether the title widget should be shown.

Parameters:

showTitle - the value for the show-title property

Returns:

the Builder instance is returned, to allow method chaining

setTitleWidget

public B setTitleWidget(Widget titleWidget)

The title widget to display.

When set to NULL, the header bar will display the title of the window it is contained in.

To use a different title, use WindowTitle:

<object class="AdwHeaderBar">
   <property name="title-widget">
     <object class="AdwWindowTitle">
       <property name="title" translatable="yes">Title</property>
     </object>
   </property>
 </object>
 

Parameters:

titleWidget - the value for the title-widget property

Returns:

the Builder instance is returned, to allow method chaining