Package org.gnome.adw

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

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface, Accessible.Builder<B>

Enclosing class:

TabView

public static class TabView.Builder<B extends TabView.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
TabView	build()	Finish building the TabView object.
B	onClosePage(TabView.ClosePageCallback handler)	Emitted after TabView.closePage(org.gnome.adw.TabPage) has been called for page.
B	onCreateWindow(TabView.CreateWindowCallback handler)	Emitted when a tab should be transferred into a new window.
B	onIndicatorActivated(TabView.IndicatorActivatedCallback handler)	Emitted after the indicator icon on page has been activated.
B	onPageAttached(TabView.PageAttachedCallback handler)	Emitted when a page has been created or transferred to self.
B	onPageDetached(TabView.PageDetachedCallback handler)	Emitted when a page has been removed or transferred to another view.
B	onPageReordered(TabView.PageReorderedCallback handler)	Emitted after page has been reordered to position.
B	onSetupMenu(TabView.SetupMenuCallback handler)	Emitted when a context menu is opened or closed for page.
B	setDefaultIcon(Icon defaultIcon)	Default page icon.
B	setMenuModel(MenuModel menuModel)	Tab context menu model.
B	setSelectedPage(TabPage selectedPage)	The currently selected page.
B	setShortcuts(Set<TabViewShortcuts> shortcuts)	The enabled shortcuts.
B	setShortcuts(TabViewShortcuts... shortcuts)	The enabled shortcuts.

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

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

Overrides:

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

Returns:

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

setDefaultIcon

public B setDefaultIcon(Icon defaultIcon)

Default page icon.

If a page doesn't provide its own icon via TabPage:icon, a default icon may be used instead for contexts where having an icon is necessary.

TabBar will use default icon for pinned tabs in case the page is not loading, doesn't have an icon and an indicator. Default icon is never used for tabs that aren't pinned.

TabOverview will use default icon for pages with missing thumbnails.

By default, the adw-tab-icon-missing-symbolic icon is used.

Parameters:

defaultIcon - the value for the default-icon property

Returns:

the Builder instance is returned, to allow method chaining

setMenuModel

public B setMenuModel(MenuModel menuModel)

Tab context menu model.

When a context menu is shown for a tab, it will be constructed from the provided menu model. Use the TabView::setup-menu signal to set up the menu actions for the particular tab.

Parameters:

menuModel - the value for the menu-model property

Returns:

the Builder instance is returned, to allow method chaining

setSelectedPage

public B setSelectedPage(TabPage selectedPage)

The currently selected page.

Parameters:

selectedPage - the value for the selected-page property

Returns:

the Builder instance is returned, to allow method chaining

setShortcuts

public B setShortcuts(Set<TabViewShortcuts> shortcuts)

The enabled shortcuts.

See TabViewShortcuts for the list of the available shortcuts. All of the shortcuts are enabled by default.

TabView.addShortcuts(java.util.Set<org.gnome.adw.TabViewShortcuts>) and TabView.removeShortcuts(java.util.Set<org.gnome.adw.TabViewShortcuts>) provide a convenient way to manage individual shortcuts.

Parameters:

shortcuts - the value for the shortcuts property

Returns:

the Builder instance is returned, to allow method chaining

setShortcuts

public B setShortcuts(TabViewShortcuts... shortcuts)

The enabled shortcuts.

See TabViewShortcuts for the list of the available shortcuts. All of the shortcuts are enabled by default.

TabView.addShortcuts(java.util.Set<org.gnome.adw.TabViewShortcuts>) and TabView.removeShortcuts(java.util.Set<org.gnome.adw.TabViewShortcuts>) provide a convenient way to manage individual shortcuts.

Parameters:

shortcuts - the value for the shortcuts property

Returns:

the Builder instance is returned, to allow method chaining

onClosePage

public B onClosePage(TabView.ClosePageCallback handler)

Emitted after TabView.closePage(org.gnome.adw.TabPage) has been called for page.

The handler is expected to call TabView.closePageFinish(org.gnome.adw.TabPage, boolean) to confirm or reject the closing.

The default handler will immediately confirm closing for non-pinned pages, or reject it for pinned pages, equivalent to the following example:

static gboolean
 close_page_cb (AdwTabView *view,
                AdwTabPage *page,
                gpointer    user_data)
 {
   adw_tab_view_close_page_finish (view, page, !adw_tab_page_get_pinned (page));

   return GDK_EVENT_STOP;
 }
 

The TabView.closePageFinish(org.gnome.adw.TabPage, boolean) call doesn't have to happen inside the handler, so can be used to do asynchronous checks before confirming the closing.

A typical reason to connect to this signal is to show a confirmation dialog for closing a tab.

The signal handler should return GDK_EVENT_STOP to stop propagation or GDK_EVENT_CONTINUE to invoke the default handler.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TabView.ClosePageCallback.run(org.gnome.adw.TabPage)

onCreateWindow

public B onCreateWindow(TabView.CreateWindowCallback handler)

Emitted when a tab should be transferred into a new window.

This can happen after a tab has been dropped on desktop.

The signal handler is expected to create a new window, position it as needed and return its AdwTabView that the page will be transferred into.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TabView.CreateWindowCallback.run()

onIndicatorActivated

public B onIndicatorActivated(TabView.IndicatorActivatedCallback handler)

Emitted after the indicator icon on page has been activated.

See TabPage:indicator-icon and TabPage:indicator-activatable.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TabView.IndicatorActivatedCallback.run(org.gnome.adw.TabPage)

onPageAttached

public B onPageAttached(TabView.PageAttachedCallback handler)

Emitted when a page has been created or transferred to self.

A typical reason to connect to this signal would be to connect to page signals for things such as updating window title.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TabView.PageAttachedCallback.run(org.gnome.adw.TabPage, int)

onPageDetached

public B onPageDetached(TabView.PageDetachedCallback handler)

Emitted when a page has been removed or transferred to another view.

A typical reason to connect to this signal would be to disconnect signal handlers connected in the TabView::page-attached handler.

It is important not to try and destroy the page child in the handler of this function as the child might merely be moved to another window; use child dispose handler for that or do it in sync with your TabView.closePageFinish(org.gnome.adw.TabPage, boolean) calls.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TabView.PageDetachedCallback.run(org.gnome.adw.TabPage, int)

onPageReordered

public B onPageReordered(TabView.PageReorderedCallback handler)

Emitted after page has been reordered to position.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TabView.PageReorderedCallback.run(org.gnome.adw.TabPage, int)

onSetupMenu

public B onSetupMenu(TabView.SetupMenuCallback handler)

Emitted when a context menu is opened or closed for page.

If the menu has been closed, page will be set to NULL.

It can be used to set up menu actions before showing the menu, for example disable actions not applicable to page.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TabView.SetupMenuCallback.run(org.gnome.adw.TabPage)