Package org.gnome.adw

Class SplitButton

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.adw.SplitButton

All Implemented Interfaces:

Accessible, Actionable, Buildable, ConstraintTarget, Proxy

@Generated("io.github.jwharm.JavaGI")
public final class SplitButton
extends Widget
implements Accessible, Actionable, Buildable, ConstraintTarget

A combined button and dropdown widget.

AdwSplitButton is typically used to present a set of actions in a menu, but allow access to one of them with a single click.

The API is very similar to Button and MenuButton, see their documentation for details.

CSS nodes

 splitbutton[.image-button][.text-button]
 ├── button
 │   ╰── <content>
 ├── separator
 ╰── menubutton
     ╰── button.toggle
         ╰── arrow
 

AdwSplitButton's CSS node is called splitbutton. It contains the css nodes: button, separator, menubutton. See MenuButton documentation for the menubutton contents.

The main CSS node will contain the .image-button or .text-button style classes matching the button contents. The nested button nodes will never contain them.

Style classes
AdwSplitButton can use some of the same style classes as Button:

• .suggested-action
• .destructive-action
• .flat
• .raised

Other style classes, like .pill, cannot be used.

Accessibility
AdwSplitButton uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SplitButton.ActivateCallback	Functional interface declaration of the ActivateCallback callback.
static class	SplitButton.Builder<B extends SplitButton.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	SplitButton.ClickedCallback	Functional interface declaration of the ClickedCallback callback.
static class	SplitButton.SplitButtonClass

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

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.Widget$Impl, Widget.WidgetClass

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

InitiallyUnowned.InitiallyUnownedClass

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

GObject.NotifyCallback, GObject.ObjectClass

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

Accessible.Accessible$Impl, Accessible.AccessibleInterface

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

Actionable.Actionable$Impl, Actionable.ActionableInterface

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

Buildable.Buildable$Impl, Buildable.BuildableIface

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

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected SplitButton	asParent()	Returns this instance as if it were its parent type.
static SplitButton.Builder<? extends SplitButton.Builder>	builder()	A SplitButton.Builder object constructs a SplitButton with the specified properties.
void	emitActivate()	Emits the "activate" signal.
void	emitClicked()	Emits the "clicked" signal.
ArrowType	getArrowDirection()	Gets the direction in which the popup will be popped up.
boolean	getCanShrink()	gets whether the button can be smaller than the natural size of its contents.
@Nullable Widget	getChild()	Gets the child widget.
String	getDropdownTooltip()	Gets the tooltip of the dropdown button of self.
@Nullable String	getIconName()	Gets the name of the icon used to automatically populate the button.
@Nullable String	getLabel()	Gets the label for self.
@Nullable MenuModel	getMenuModel()	Gets the menu model from which the popup will be created.
@Nullable Popover	getPopover()	Gets the popover that will be popped up when the dropdown is clicked.
static @Nullable Type	getType()	Get the GType of the SplitButton class
boolean	getUseUnderline()	Gets whether an underline in the text indicates a mnemonic.
SignalConnection<SplitButton.ActivateCallback>	onActivate(SplitButton.ActivateCallback handler)	Emitted to animate press then release.
SignalConnection<SplitButton.ClickedCallback>	onClicked(SplitButton.ClickedCallback handler)	Emitted when the button has been activated (pressed and released).
void	popdown()	Dismisses the menu.
void	popup()	Pops up the menu.
void	setCanShrink(boolean canShrink)	Sets whether the button can be smaller than the natural size of its contents.
void	setChild(@Nullable Widget child)	Sets the child widget.
void	setDirection(ArrowType direction)	Sets the direction in which the popup will be popped up.
void	setDropdownTooltip(String tooltip)	Sets the tooltip of the dropdown button of self.
void	setIconName(String iconName)	Sets the name of the icon used to automatically populate the button.
void	setLabel(String label)	Sets the label for self.
void	setMenuModel(@Nullable MenuModel menuModel)	Sets the menu model from which the popup will be created.
void	setPopover(@Nullable Popover popover)	Sets the popover that will be popped up when the dropdown is clicked.
void	setUseUnderline(boolean useUnderline)	Sets whether an underline in the text indicates a mnemonic.

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMemoryLayout, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

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.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Actionable

getActionName, getActionTargetValue, setActionName, setActionTarget, setActionTargetValue, setDetailedActionName

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

SplitButton

public SplitButton(MemorySegment address)

Create a SplitButton proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

SplitButton

public SplitButton()

Creates a new SplitButton.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the SplitButton class

Returns:

the GType

asParent

protected SplitButton 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 Widget

getCanShrink

public boolean getCanShrink()

gets whether the button can be smaller than the natural size of its contents.

Returns:

whether the button can shrink

Since:

1.4

getChild

public @Nullable Widget getChild()

Gets the child widget.

Returns:

the child widget

getArrowDirection

public ArrowType getArrowDirection()

Gets the direction in which the popup will be popped up.

Returns:

the direction

getDropdownTooltip

public String getDropdownTooltip()

Gets the tooltip of the dropdown button of self.

Returns:

the dropdown tooltip of this SplitButton

Since:

1.2

getIconName

public @Nullable String getIconName()

Gets the name of the icon used to automatically populate the button.

Returns:

the icon name

getLabel

public @Nullable String getLabel()

Gets the label for self.

Returns:

the label for this SplitButton

getMenuModel

public @Nullable MenuModel getMenuModel()

Gets the menu model from which the popup will be created.

Returns:

the menu model

getPopover

public @Nullable Popover getPopover()

Gets the popover that will be popped up when the dropdown is clicked.

Returns:

the popover

getUseUnderline

public boolean getUseUnderline()

Gets whether an underline in the text indicates a mnemonic.

Returns:

whether an underline in the text indicates a mnemonic

popdown

public void popdown()

Dismisses the menu.

popup

public void popup()

Pops up the menu.

setCanShrink

public void setCanShrink(boolean canShrink)

Sets whether the button can be smaller than the natural size of its contents.

If set to TRUE, the label will ellipsize.

See Button.setCanShrink(boolean) and MenuButton.setCanShrink(boolean).

Parameters:

canShrink - whether the button can shrink

Since:

1.4

setChild

public void setChild(@Nullable Widget child)

Sets the child widget.

Setting the child widget will set SplitButton:label and SplitButton:icon-name to NULL.

Parameters:

child - the new child widget

setDirection

public void setDirection(ArrowType direction)

Sets the direction in which the popup will be popped up.

The dropdown arrow icon will point at the same direction.

If the does not fit in the available space in the given direction, GTK will try its best to keep it inside the screen and fully visible.

If you pass GTK_ARROW_NONE, it's equivalent to GTK_ARROW_DOWN.

Parameters:

direction - the direction

setDropdownTooltip

public void setDropdownTooltip(String tooltip)

Sets the tooltip of the dropdown button of self.

The tooltip can be marked up with the Pango text markup language.

Parameters:

tooltip - the dropdown tooltip of this SplitButton

Since:

1.2

setIconName

public void setIconName(String iconName)

Sets the name of the icon used to automatically populate the button.

Setting the icon name will set SplitButton:label and SplitButton:child to NULL.

Parameters:

iconName - the icon name to set

setLabel

public void setLabel(String label)

Sets the label for self.

Setting the label will set SplitButton:icon-name and SplitButton:child to NULL.

Parameters:

label - the label to set

setMenuModel

public void setMenuModel(@Nullable MenuModel menuModel)

Sets the menu model from which the popup will be created.

If the menu model is NULL, the dropdown is disabled.

A Popover will be created from the menu model with PopoverMenu.fromModel(org.gnome.gio.MenuModel). Actions will be connected as documented for this function.

If SplitButton:popover is already set, it will be dissociated from the button, and the property is set to NULL.

Parameters:

menuModel - the menu model

setPopover

public void setPopover(@Nullable Popover popover)

Sets the popover that will be popped up when the dropdown is clicked.

If the popover is NULL, the dropdown is disabled.

If SplitButton:menu-model is set, the menu model is dissociated from the button, and the property is set to NULL.

Parameters:

popover - the popover

setUseUnderline

public void setUseUnderline(boolean useUnderline)

Sets whether an underline in the text indicates a mnemonic.

See SplitButton:label.

Parameters:

useUnderline - whether an underline in the text indicates a mnemonic

onActivate

public SignalConnection<SplitButton.ActivateCallback> onActivate(SplitButton.ActivateCallback handler)

Emitted to animate press then release.

This is an action signal. Applications should never connect to this signal, but use the SplitButton::clicked signal.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SplitButton.ActivateCallback.run()

emitActivate

public void emitActivate()

Emits the "activate" signal. See onActivate(org.gnome.adw.SplitButton.ActivateCallback).

onClicked

public SignalConnection<SplitButton.ClickedCallback> onClicked(SplitButton.ClickedCallback handler)

Emitted when the button has been activated (pressed and released).

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SplitButton.ClickedCallback.run()

emitClicked

public void emitClicked()

Emits the "clicked" signal. See onClicked(org.gnome.adw.SplitButton.ClickedCallback).

builder

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

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

Returns:

the builder object