Class OverlaySplitView

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.OverlaySplitView
All Implemented Interfaces:
Swipeable, Accessible, Buildable, ConstraintTarget, Proxy
@Generated("org.javagi.JavaGI") public final class OverlaySplitView extends Widget implements Swipeable, Accessible, Buildable, ConstraintTarget

A widget presenting sidebar and content side by side or as an overlay.

overlay-split-view overlay-split-view-collapsed

AdwOverlaySplitView has two children: sidebar and content, and displays them side by side.

When OverlaySplitView:collapsed is set to TRUE, the sidebar is instead shown as an overlay above the content widget.

The sidebar can be hidden or shown using the OverlaySplitView:show-sidebar property.

Sidebar can be displayed before or after the content, this can be controlled with the OverlaySplitView:sidebar-position property.

Collapsing the split view automatically hides the sidebar widget, and uncollapsing it shows the sidebar. If this behavior is not desired, the OverlaySplitView:pin-sidebar property can be used to override it.

AdwOverlaySplitView supports an edge swipe gesture for showing the sidebar, and a swipe from the sidebar for hiding it. Gestures are only supported on touchscreen, but not touchpad. Gestures can be controlled with the OverlaySplitView:enable-show-gesture and OverlaySplitView:enable-hide-gesture properties.

See also NavigationSplitView.

AdwOverlaySplitView is typically used together with an Breakpoint setting the collapsed property to TRUE on small widths, as follows:

<object class="AdwWindow">
  <property name="default-width">800</property>
  <property name="default-height">800</property>
  <child>
    <object class="AdwBreakpoint">
      <condition>max-width: 400sp</condition>
      <setter object="split_view" property="collapsed">True</setter>
    </object>
  </child>
  <property name="content">
    <object class="AdwOverlaySplitView" id="split_view">
      <property name="sidebar">
        <!-- ... -->
      </property>
      <property name="content">
        <!-- ... -->
      </property>
    </object>
  </property>
</object>

AdwOverlaySplitView is often used for implementing the utility pane pattern.

Sizing

When not collapsed, AdwOverlaySplitView changes the sidebar width depending on its own width.

If possible, it tries to allocate a fraction of the total width, controlled with the OverlaySplitView:sidebar-width-fraction property.

The sidebar also has minimum and maximum sizes, controlled with the OverlaySplitView:min-sidebar-width and OverlaySplitView:max-sidebar-width properties.

The minimum and maximum sizes are using the length unit specified with the OverlaySplitView:sidebar-width-unit.

By default, sidebar is using 25% of the total width, with 180sp as the minimum size and 280sp as the maximum size.

When collapsed, the preferred width fraction is ignored and the sidebar uses OverlaySplitView:max-sidebar-width when possible.

Header Bar Integration

When used inside AdwOverlaySplitView, HeaderBar will automatically hide the window buttons in the middle.

AdwOverlaySplitView as GtkBuildable

The AdwOverlaySplitView implementation of the Buildable interface supports setting the sidebar widget by specifying “sidebar” as the “type” attribute of a <child> element, Specifying “content” child type or omitting it results in setting the content widget.

CSS nodes

AdwOverlaySplitView has a single CSS node with the name overlay-split-view.

It contains two nodes with the name widget, containing the sidebar and content children.

When not collapsed, they have the .sidebar-view and .content-view style classes respectively.

overlay-split-view
├── widget.sidebar-pane
│   ╰── [sidebar child]
╰── widget.content-pane
    ╰── [content child]

When collapsed, the one containing the sidebar child has the .background style class and the other one has no style classes.

overlay-split-view
├── widget.background
│   ╰── [sidebar child]
╰── widget
    ╰── [content child]

Accessibility

AdwOverlaySplitView uses the Gtk.AccessibleRole.group role.

Since:
1.4

  • Constructor Details

    • OverlaySplitView

      public OverlaySplitView(MemorySegment address)
      Create a OverlaySplitView instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • OverlaySplitView

      public OverlaySplitView()
      Create a new OverlaySplitView.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the OverlaySplitView class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • asParent

      protected OverlaySplitView asParent()
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class Widget
      Returns:
      the instance as if it were its parent type

    • getCollapsed

      public boolean getCollapsed()
      Gets whether this OverlaySplitView is collapsed.
      Returns:
      whether this OverlaySplitView is collapsed
      Since:
      1.4

    • getContent

      public @Nullable Widget getContent()
      Gets the content widget for self.
      Returns:
      the content widget for this OverlaySplitView
      Since:
      1.4

    • getEnableHideGesture

      public boolean getEnableHideGesture()
      Gets whether this OverlaySplitView can be closed with a swipe gesture.
      Returns:
      TRUE if this OverlaySplitView can be closed with a swipe gesture
      Since:
      1.4

    • getEnableShowGesture

      public boolean getEnableShowGesture()
      Gets whether this OverlaySplitView can be opened with an edge swipe gesture.
      Returns:
      TRUE if this OverlaySplitView can be opened with a swipe gesture
      Since:
      1.4

    • getMaxSidebarWidth

      public double getMaxSidebarWidth()
      Gets the maximum sidebar width for self.
      Returns:
      the maximum width
      Since:
      1.4

    • getMinSidebarWidth

      public double getMinSidebarWidth()
      Gets the minimum sidebar width for self.
      Returns:
      the minimum width
      Since:
      1.4

    • getPinSidebar

      public boolean getPinSidebar()
      Gets whether the sidebar widget is pinned for self.
      Returns:
      whether if the sidebar widget is pinned
      Since:
      1.4

    • getShowSidebar

      public boolean getShowSidebar()
      Gets whether the sidebar widget is shown for self.
      Returns:
      TRUE if the sidebar widget is shown
      Since:
      1.4

    • getSidebar

      public @Nullable Widget getSidebar()
      Gets the sidebar widget for self.
      Returns:
      the sidebar widget for this OverlaySplitView
      Since:
      1.4

    • getSidebarPosition

      public PackType getSidebarPosition()
      Gets the sidebar position for self.
      Returns:
      the sidebar position for this OverlaySplitView
      Since:
      1.4

    • getSidebarWidthFraction

      public double getSidebarWidthFraction()
      Gets the preferred sidebar width fraction for self.
      Returns:
      the preferred width fraction
      Since:
      1.4

    • getSidebarWidthUnit

      public LengthUnit getSidebarWidthUnit()
      Gets the length unit for minimum and maximum sidebar widths.
      Returns:
      the length unit
      Since:
      1.4

    • setCollapsed

      public void setCollapsed(boolean collapsed)

      Sets whether this OverlaySplitView view is collapsed.

      When collapsed, the sidebar widget is presented as an overlay above the content widget, otherwise they are displayed side by side.

      Parameters:
      collapsed - whether this OverlaySplitView is collapsed
      Since:
      1.4

    • setContent

      public void setContent(@Nullable Widget content)
      Sets the content widget for self.
      Parameters:
      content - the content widget
      Since:
      1.4

    • setEnableHideGesture

      public void setEnableHideGesture(boolean enableHideGesture)

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

      Only touchscreen swipes are supported.

      Parameters:
      enableHideGesture - whether this OverlaySplitView can be closed with a swipe gesture
      Since:
      1.4

    • setEnableShowGesture

      public void setEnableShowGesture(boolean enableShowGesture)

      Sets whether this OverlaySplitView can be opened with an edge swipe gesture.

      Only touchscreen swipes are supported.

      Parameters:
      enableShowGesture - whether this OverlaySplitView can be opened with a swipe gesture
      Since:
      1.4

    • setMaxSidebarWidth

      public void setMaxSidebarWidth(double width)

      Sets the maximum sidebar width for self.

      Maximum width is affected by OverlaySplitView:sidebar-width-unit.

      The sidebar widget can still be allocated with larger width if its own minimum width exceeds it.

      Parameters:
      width - the maximum width
      Since:
      1.4

    • setMinSidebarWidth

      public void setMinSidebarWidth(double width)

      Sets the minimum sidebar width for self.

      Minimum width is affected by OverlaySplitView:sidebar-width-unit.

      The sidebar widget can still be allocated with larger width if its own minimum width exceeds it.

      Parameters:
      width - the minimum width
      Since:
      1.4

    • setPinSidebar

      public void setPinSidebar(boolean pinSidebar)

      Sets whether the sidebar widget is pinned for self.

      By default, collapsing this OverlaySplitView automatically hides the sidebar widget, and uncollapsing it shows the sidebar. If set to TRUE, sidebar visibility never changes on its own.

      Parameters:
      pinSidebar - whether to pin the sidebar widget
      Since:
      1.4

    • setShowSidebar

      public void setShowSidebar(boolean showSidebar)
      Sets whether the sidebar widget is shown for self.
      Parameters:
      showSidebar - whether to show the sidebar widget
      Since:
      1.4

    • setSidebar

      public void setSidebar(@Nullable Widget sidebar)
      Sets the sidebar widget for self.
      Parameters:
      sidebar - the sidebar widget
      Since:
      1.4

    • setSidebarPosition

      public void setSidebarPosition(PackType position)

      Sets the sidebar position for self.

      If it's set to Gtk.PackType.start, the sidebar is displayed before the content; if Gtk.PackType.end, it's displayed after the content.

      Parameters:
      position - the new position
      Since:
      1.4

    • setSidebarWidthFraction

      public void setSidebarWidthFraction(double fraction)

      Sets the preferred sidebar width as a fraction of the total width of self.

      The preferred width is additionally limited by OverlaySplitView:min-sidebar-width and OverlaySplitView:max-sidebar-width.

      The sidebar widget can be allocated with larger width if its own minimum width exceeds the preferred width.

      Parameters:
      fraction - the preferred width fraction
      Since:
      1.4

    • setSidebarWidthUnit

      public void setSidebarWidthUnit(LengthUnit unit)

      Sets the length unit for minimum and maximum sidebar widths.

      See OverlaySplitView:min-sidebar-width and OverlaySplitView:max-sidebar-width.

      Parameters:
      unit - the length unit
      Since:
      1.4

    • builder

      public static OverlaySplitView.Builder<? extends OverlaySplitView.Builder> builder()
      A OverlaySplitView.Builder object constructs a OverlaySplitView with the specified properties. Use the various set...() methods to set properties, and finish construction with OverlaySplitView.Builder.build().
      Returns:
      the builder object