Package org.gnome.adw

Class Flap

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

All Implemented Interfaces:

Swipeable, Accessible, Buildable, ConstraintTarget, Orientable, Proxy

@Generated("io.github.jwharm.JavaGI")
@Deprecated
public final class Flap
extends Widget
implements Swipeable, Accessible, Buildable, ConstraintTarget, Orientable

Deprecated.

See the migration guide

An adaptive container acting like a box or an overlay.

The AdwFlap widget can display its children like a Box does or like a Overlay does, according to the Flap:fold-policy value.

AdwFlap has at most three children: Flap:content, Flap:flap and Flap:separator. Content is the primary child, flap is displayed next to it when unfolded, or overlays it when folded. Flap can be shown or hidden by changing the Flap:reveal-flap value, as well as via swipe gestures if Flap:swipe-to-open and/or Flap:swipe-to-close are set to TRUE.

Optionally, a separator can be provided, which would be displayed between the content and the flap when there's no shadow to separate them, depending on the transition type.

Flap:flap is transparent by default; add the .background style class to it if this is unwanted.

If Flap:modal is set to TRUE, content becomes completely inaccessible when the flap is revealed while folded.

The position of the flap and separator children relative to the content is determined by orientation, as well as the Flap:flap-position value.

Folding the flap will automatically hide the flap widget, and unfolding it will automatically reveal it. If this behavior is not desired, the Flap:locked property can be used to override it.

Common use cases include sidebars, header bars that need to be able to overlap the window content (for example, in fullscreen mode) and bottom sheets.

AdwFlap as GtkBuildable
The AdwFlap implementation of the Buildable interface supports setting the flap child by specifying “flap” as the “type” attribute of a <child> element, and separator by specifying “separator”. Specifying “content” child type or omitting it results in setting the content child.

CSS nodes
AdwFlap has a single CSS node with name flap. The node will get the style classes .folded when it is folded, and .unfolded when it's not.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Flap.Builder<B extends Flap.Builder<B>>	Deprecated. Inner class implementing a builder pattern to construct a GObject with properties.
static class	Flap.FlapClass	Deprecated.

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

Buildable.Buildable$Impl, Buildable.BuildableIface

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

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

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

Orientable.Orientable$Impl, Orientable.OrientableIface

Nested classes/interfaces inherited from interface org.gnome.adw.Swipeable

Swipeable.Swipeable$Impl, Swipeable.SwipeableInterface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Flap	asParent()	Deprecated. Returns this instance as if it were its parent type.
static Flap.Builder<? extends Flap.Builder>	builder()	Deprecated. A Flap.Builder object constructs a Flap with the specified properties.
@Nullable Widget	getContent()	Deprecated. See the migration guide
@Nullable Widget	getFlap()	Deprecated. See the migration guide
PackType	getFlapPosition()	Deprecated. See the migration guide
int	getFoldDuration()	Deprecated. See the migration guide
boolean	getFolded()	Deprecated. See the migration guide
FlapFoldPolicy	getFoldPolicy()	Deprecated. See the migration guide
FoldThresholdPolicy	getFoldThresholdPolicy()	Deprecated. See the migration guide
boolean	getLocked()	Deprecated. See the migration guide
boolean	getModal()	Deprecated. See the migration guide
boolean	getRevealFlap()	Deprecated. See the migration guide
SpringParams	getRevealParams()	Deprecated. See the migration guide
double	getRevealProgress()	Deprecated. See the migration guide
@Nullable Widget	getSeparator()	Deprecated. See the migration guide
boolean	getSwipeToClose()	Deprecated. See the migration guide
boolean	getSwipeToOpen()	Deprecated. See the migration guide
FlapTransitionType	getTransitionType()	Deprecated. See the migration guide
static @Nullable Type	getType()	Deprecated. Get the GType of the Flap class
void	setContent(@Nullable Widget content)	Deprecated. See the migration guide
void	setFlap(@Nullable Widget flap)	Deprecated. See the migration guide
void	setFlapPosition(PackType position)	Deprecated. See the migration guide
void	setFoldDuration(int duration)	Deprecated. See the migration guide
void	setFoldPolicy(FlapFoldPolicy policy)	Deprecated. See the migration guide
void	setFoldThresholdPolicy(FoldThresholdPolicy policy)	Deprecated. See the migration guide
void	setLocked(boolean locked)	Deprecated. See the migration guide
void	setModal(boolean modal)	Deprecated. See the migration guide
void	setRevealFlap(boolean revealFlap)	Deprecated. See the migration guide
void	setRevealParams(SpringParams params)	Deprecated. See the migration guide
void	setSeparator(@Nullable Widget separator)	Deprecated. See the migration guide
void	setSwipeToClose(boolean swipeToClose)	Deprecated. See the migration guide
void	setSwipeToOpen(boolean swipeToOpen)	Deprecated. See the migration guide
void	setTransitionType(FlapTransitionType transitionType)	Deprecated. See the migration guide

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

getBuildableId

Methods inherited from interface org.gnome.gtk.Orientable

getOrientation, setOrientation

Methods inherited from interface org.javagi.base.Proxy

handle

Methods inherited from interface org.gnome.adw.Swipeable

getCancelProgress, getDistance, getProgress, getSnapPoints, getSwipeArea

Constructor Details

Flap

public Flap(MemorySegment address)

Deprecated.

Create a Flap proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Flap

public Flap()

Deprecated.

Creates a new Flap.

Method Details

getType

public static @Nullable Type getType()

Deprecated.

Get the GType of the Flap class

Returns:

the GType

asParent

protected Flap asParent()

Deprecated.

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

getContent

@Deprecated
public @Nullable Widget getContent()

Deprecated.

See the migration guide

Gets the content widget for self.

Returns:

the content widget for this Flap

getFlap

@Deprecated
public @Nullable Widget getFlap()

Deprecated.

See the migration guide

Gets the flap widget for self.

Returns:

the flap widget for this Flap

getFlapPosition

@Deprecated
public PackType getFlapPosition()

Deprecated.

See the migration guide

Gets the flap position for self.

Returns:

the flap position for this Flap

getFoldDuration

@Deprecated
public int getFoldDuration()

Deprecated.

See the migration guide

Gets the fold transition animation duration for self, in milliseconds.

Returns:

the fold transition duration

getFoldPolicy

@Deprecated
public FlapFoldPolicy getFoldPolicy()

Deprecated.

See the migration guide

Gets the fold policy for self.

Returns:

the fold policy for this Flap

getFoldThresholdPolicy

@Deprecated
public FoldThresholdPolicy getFoldThresholdPolicy()

Deprecated.

See the migration guide

Gets the fold threshold policy for self.

Returns:

the fold threshold policy

getFolded

@Deprecated
public boolean getFolded()

Deprecated.

See the migration guide

Gets whether this Flap is currently folded.

See Flap:fold-policy.

Returns:

TRUE if this Flap is currently folded

getLocked

@Deprecated
public boolean getLocked()

Deprecated.

See the migration guide

Gets whether this Flap is locked.

Returns:

TRUE if this Flap is locked

getModal

@Deprecated
public boolean getModal()

Deprecated.

See the migration guide

Gets whether this Flap is modal.

Returns:

TRUE if this Flap is modal

getRevealFlap

@Deprecated
public boolean getRevealFlap()

Deprecated.

See the migration guide

Gets whether the flap widget is revealed for self.

Returns:

TRUE if the flap widget is revealed

getRevealParams

@Deprecated
public SpringParams getRevealParams()

Deprecated.

See the migration guide

Gets the reveal animation spring parameters for self.

Returns:

the reveal animation parameters

getRevealProgress

@Deprecated
public double getRevealProgress()

Deprecated.

See the migration guide

Gets the current reveal progress for self.

0 means fully hidden, 1 means fully revealed.

See Flap:reveal-flap.

Returns:

the current reveal progress for this Flap

getSeparator

@Deprecated
public @Nullable Widget getSeparator()

Deprecated.

See the migration guide

Gets the separator widget for self.

Returns:

the separator widget for this Flap

getSwipeToClose

@Deprecated
public boolean getSwipeToClose()

Deprecated.

See the migration guide

Gets whether this Flap can be closed with a swipe gesture.

Returns:

TRUE if this Flap can be closed with a swipe gesture

getSwipeToOpen

@Deprecated
public boolean getSwipeToOpen()

Deprecated.

See the migration guide

Gets whether this Flap can be opened with a swipe gesture.

Returns:

TRUE if this Flap can be opened with a swipe gesture

getTransitionType

@Deprecated
public FlapTransitionType getTransitionType()

Deprecated.

See the migration guide

Gets the type of animation used for reveal and fold transitions in self.

Returns:

the current transition type of this Flap

setContent

@Deprecated
public void setContent(@Nullable Widget content)

Deprecated.

See the migration guide

Sets the content widget for self.

It's always displayed when unfolded, and partially visible when folded.

Parameters:

content - the content widget

setFlap

@Deprecated
public void setFlap(@Nullable Widget flap)

Deprecated.

See the migration guide

Sets the flap widget for self.

It's only visible when Flap:reveal-progress is greater than 0.

Parameters:

flap - the flap widget

setFlapPosition

@Deprecated
public void setFlapPosition(PackType position)

Deprecated.

See the migration guide

Sets the flap position for self.

If it's set to GTK_PACK_START, the flap is displayed before the content, if GTK_PACK_END, it's displayed after the content.

Parameters:

position - the new value

setFoldDuration

@Deprecated
public void setFoldDuration(int duration)

Deprecated.

See the migration guide

Sets the fold transition animation duration for self, in milliseconds.

Parameters:

duration - the new duration, in milliseconds

setFoldPolicy

@Deprecated
public void setFoldPolicy(FlapFoldPolicy policy)

Deprecated.

See the migration guide

Sets the fold policy for self.

Parameters:

policy - the fold policy

setFoldThresholdPolicy

@Deprecated
public void setFoldThresholdPolicy(FoldThresholdPolicy policy)

Deprecated.

See the migration guide

Sets the fold threshold policy for self.

If set to ADW_FOLD_THRESHOLD_POLICY_MINIMUM, flap will only fold when the children cannot fit anymore. With ADW_FOLD_THRESHOLD_POLICY_NATURAL, it will fold as soon as children don't get their natural size.

This can be useful if you have a long ellipsizing label and want to let it ellipsize instead of immediately folding.

Parameters:

policy - the policy to use

setLocked

@Deprecated
public void setLocked(boolean locked)

Deprecated.

See the migration guide

Sets whether this Flap is locked.

If FALSE, folding when the flap is revealed automatically closes it, and unfolding it when the flap is not revealed opens it. If TRUE, Flap:reveal-flap value never changes on its own.

Parameters:

locked - the new value

setModal

@Deprecated
public void setModal(boolean modal)

Deprecated.

See the migration guide

Sets whether this Flap is modal.

If TRUE, clicking the content widget while flap is revealed, as well as pressing the Esc key, will close the flap. If FALSE, clicks are passed through to the content widget.

Parameters:

modal - whether this Flap is modal

setRevealFlap

@Deprecated
public void setRevealFlap(boolean revealFlap)

Deprecated.

See the migration guide

Sets whether the flap widget is revealed for self.

Parameters:

revealFlap - whether to reveal the flap widget

setRevealParams

@Deprecated
public void setRevealParams(SpringParams params)

Deprecated.

See the migration guide

Sets the reveal animation spring parameters for self.

The default value is equivalent to:

adw_spring_params_new (1, 0.5, 500)
 

Parameters:

params - the new parameters

setSeparator

@Deprecated
public void setSeparator(@Nullable Widget separator)

Deprecated.

See the migration guide

Sets the separator widget for self.

It's displayed between content and flap when there's no shadow to display. When exactly it's visible depends on the Flap:transition-type value.

Parameters:

separator - the separator widget

setSwipeToClose

@Deprecated
public void setSwipeToClose(boolean swipeToClose)

Deprecated.

See the migration guide

Sets whether this Flap can be closed with a swipe gesture.

The area that can be swiped depends on the Flap:transition-type value.

Parameters:

swipeToClose - whether this Flap can be closed with a swipe gesture

setSwipeToOpen

@Deprecated
public void setSwipeToOpen(boolean swipeToOpen)

Deprecated.

See the migration guide

Sets whether this Flap can be opened with a swipe gesture.

The area that can be swiped depends on the Flap:transition-type value.

Parameters:

swipeToOpen - whether this Flap can be opened with a swipe gesture

setTransitionType

@Deprecated
public void setTransitionType(FlapTransitionType transitionType)

Deprecated.

See the migration guide

Sets the type of animation used for reveal and fold transitions in self.

Flap:flap is transparent by default, which means the content will be seen through it with ADW_FLAP_TRANSITION_TYPE_OVER transitions; add the .background style class to it if this is unwanted.

Parameters:

transitionType - the new transition type

builder

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

Deprecated.

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

Returns:

the builder object