Package org.gnome.adw

Class Banner

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

All Implemented Interfaces:

Accessible, Actionable, Buildable, ConstraintTarget, Proxy

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

A bar with contextual information.

Banners are hidden by default, use Banner:revealed to show them.

Banners have a title, set with Banner:title. Titles can be marked up with Pango markup, use Banner:use-markup to enable it.

The title will be shown centered or left-aligned depending on available space.

Banners can optionally have a button with text on it, set through Banner:button-label. The button can be used with a GAction, or with the Banner::button-clicked signal. The button can have different styles, a gray style and a suggested style.

CSS nodes
AdwBanner has a main CSS node with the name banner.

Since:

1.3

Nested Class Summary

Nested Classes

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

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
Banner()	Creates a new Banner.
Banner(MemorySegment address)	Create a Banner proxy instance for the provided memory address.
Banner(String title)	Creates a new AdwBanner.

Method Summary

Modifier and Type	Method	Description
protected Banner	asParent()	Returns this instance as if it were its parent type.
static Banner.Builder<? extends Banner.Builder>	builder()	A Banner.Builder object constructs a Banner with the specified properties.
void	emitButtonClicked()	Emits the "button-clicked" signal.
@Nullable String	getButtonLabel()	Gets the button label for self.
BannerButtonStyle	getButtonStyle()	Gets the style class in use for the banner button.
boolean	getRevealed()	Gets if a banner is revealed
String	getTitle()	Gets the title for self.
static @Nullable Type	getType()	Get the GType of the Banner class
boolean	getUseMarkup()	Gets whether to use Pango markup for the banner title.
SignalConnection<Banner.ButtonClickedCallback>	onButtonClicked(Banner.ButtonClickedCallback handler)	This signal is emitted after the action button has been clicked.
void	setButtonLabel(@Nullable String label)	Sets the button label for self.
void	setButtonStyle(BannerButtonStyle style)	Sets the style class to use for the banner button.
void	setRevealed(boolean revealed)	Sets whether a banner should be revealed
void	setTitle(String title)	Sets the title for this banner.
void	setUseMarkup(boolean useMarkup)	Sets whether to use Pango markup for the banner title.

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

Banner

public Banner(MemorySegment address)

Create a Banner proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Banner

public Banner(String title)

Creates a new AdwBanner.

Parameters:

title - the banner title

Since:

1.3

Banner

public Banner()

Creates a new Banner.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Banner class

Returns:

the GType

asParent

protected Banner 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

getButtonLabel

public @Nullable String getButtonLabel()

Gets the button label for self.

Returns:

the button label for this Banner

Since:

1.3

getButtonStyle

public BannerButtonStyle getButtonStyle()

Gets the style class in use for the banner button.

Returns:

the current button style

Since:

1.7

getRevealed

public boolean getRevealed()

Gets if a banner is revealed

Returns:

Whether a banner is revealed

Since:

1.3

getTitle

public String getTitle()

Gets the title for self.

Returns:

the title for this Banner

Since:

1.3

getUseMarkup

public boolean getUseMarkup()

Gets whether to use Pango markup for the banner title.

Returns:

whether to use markup

Since:

1.3

setButtonLabel

public void setButtonLabel(@Nullable String label)

Sets the button label for self.

If set to "" or NULL, the button won't be shown.

The button can be used with a GAction, or with the Banner::button-clicked signal.

Parameters:

label - the label

Since:

1.3

setButtonStyle

public void setButtonStyle(BannerButtonStyle style)

Sets the style class to use for the banner button.

When set to ADW_BANNER_BUTTON_DEFAULT, the button stays grey. When set to ADW_BANNER_BUTTON_SUGGESTED, the button follows the .suggested-action style

Parameters:

style - a button style

Since:

1.7

setRevealed

public void setRevealed(boolean revealed)

Sets whether a banner should be revealed

Parameters:

revealed - whether a banner should be revealed

Since:

1.3

setTitle

public void setTitle(String title)

Sets the title for this banner.

See also: Banner:use-markup.

Parameters:

title - the title

Since:

1.3

setUseMarkup

public void setUseMarkup(boolean useMarkup)

Sets whether to use Pango markup for the banner title.

See also Pango.parseMarkup(java.lang.String, int, int, org.javagi.base.Out<org.gnome.pango.AttrList>, org.javagi.base.Out<java.lang.String>, org.javagi.base.Out<java.lang.Integer>).

Parameters:

useMarkup - whether to use markup

Since:

1.3

onButtonClicked

public SignalConnection<Banner.ButtonClickedCallback> onButtonClicked(Banner.ButtonClickedCallback handler)

This signal is emitted after the action button has been clicked.

It can be used as an alternative to setting an action.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

1.3

See Also:

• Banner.ButtonClickedCallback.run()

emitButtonClicked

public void emitButtonClicked()

Emits the "button-clicked" signal. See onButtonClicked(org.gnome.adw.Banner.ButtonClickedCallback).

builder

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

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

Returns:

the builder object