Class Flap.Builder<B extends Flap.Builder<B>>

java.lang.Object
org.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.Flap.Builder<B>
Type Parameters:
B - the type of the Builder that is returned
All Implemented Interfaces:
Accessible.Builder<B>, Orientable.Builder<B>, BuilderInterface
Enclosing class:
Flap
public static class Flap.Builder<B extends Flap.Builder<B>> extends Widget.Builder<B> implements Accessible.Builder<B>, Orientable.Builder<B>
Inner class implementing a builder pattern to construct a GObject with properties.

  • Constructor Details

    • Builder

      protected Builder()
      Default constructor for a Builder object.

  • Method Details

    • build

      public Flap build()
      Finish building the Flap object. This will call GObject.withProperties(Type, String[], Value[]) to create a new GObject instance, which is then cast to Flap.
      Overrides:
      build in class Widget.Builder<B extends Flap.Builder<B>>
      Returns:
      a new instance of Flap with the properties that were set in the Builder object.

    • setContent

      @Deprecated public B setContent(Widget content)
      Deprecated.
      See the migration guide

      The content widget.

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

      Parameters:
      content - the value for the content property
      Returns:
      the Builder instance is returned, to allow method chaining

    • setFlap

      @Deprecated public B setFlap(Widget flap)
      Deprecated.
      See the migration guide

      The flap widget.

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

      Parameters:
      flap - the value for the flap property
      Returns:
      the Builder instance is returned, to allow method chaining

    • setFlapPosition

      @Deprecated public B setFlapPosition(PackType flapPosition)
      Deprecated.
      See the migration guide

      The flap position.

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

      Parameters:
      flapPosition - the value for the flap-position property
      Returns:
      the Builder instance is returned, to allow method chaining

    • setFoldDuration

      @Deprecated public B setFoldDuration(int foldDuration)
      Deprecated.
      See the migration guide
      The fold transition animation duration, in milliseconds.
      Parameters:
      foldDuration - the value for the fold-duration property
      Returns:
      the Builder instance is returned, to allow method chaining

    • setFoldPolicy

      @Deprecated public B setFoldPolicy(FlapFoldPolicy foldPolicy)
      Deprecated.
      See the migration guide
      The fold policy for the flap.
      Parameters:
      foldPolicy - the value for the fold-policy property
      Returns:
      the Builder instance is returned, to allow method chaining

    • setFoldThresholdPolicy

      @Deprecated public B setFoldThresholdPolicy(FoldThresholdPolicy foldThresholdPolicy)
      Deprecated.
      See the migration guide

      Determines when the flap will fold.

      If set to Adw.FoldThresholdPolicy.minimum, flap will only fold when the children cannot fit anymore. With Adw.FoldThresholdPolicy.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:
      foldThresholdPolicy - the value for the fold-threshold-policy property
      Returns:
      the Builder instance is returned, to allow method chaining

    • setLocked

      @Deprecated public B setLocked(boolean locked)
      Deprecated.
      See the migration guide

      Whether the 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 value for the locked property
      Returns:
      the Builder instance is returned, to allow method chaining

    • setModal

      @Deprecated public B setModal(boolean modal)
      Deprecated.
      See the migration guide

      Whether the 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 - the value for the modal property
      Returns:
      the Builder instance is returned, to allow method chaining

    • setRevealFlap

      @Deprecated public B setRevealFlap(boolean revealFlap)
      Deprecated.
      See the migration guide
      Whether the flap widget is revealed.
      Parameters:
      revealFlap - the value for the reveal-flap property
      Returns:
      the Builder instance is returned, to allow method chaining

    • setRevealParams

      @Deprecated public B setRevealParams(SpringParams revealParams)
      Deprecated.
      See the migration guide

      The reveal animation spring parameters.

      The default value is equivalent to:

      adw_spring_params_new (1, 0.5, 500)
      Parameters:
      revealParams - the value for the reveal-params property
      Returns:
      the Builder instance is returned, to allow method chaining

    • setSeparator

      @Deprecated public B setSeparator(Widget separator)
      Deprecated.
      See the migration guide

      The separator widget.

      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 value for the separator property
      Returns:
      the Builder instance is returned, to allow method chaining

    • setSwipeToClose

      @Deprecated public B setSwipeToClose(boolean swipeToClose)
      Deprecated.
      See the migration guide

      Whether the flap can be closed with a swipe gesture.

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

      Parameters:
      swipeToClose - the value for the swipe-to-close property
      Returns:
      the Builder instance is returned, to allow method chaining

    • setSwipeToOpen

      @Deprecated public B setSwipeToOpen(boolean swipeToOpen)
      Deprecated.
      See the migration guide

      Whether the flap can be opened with a swipe gesture.

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

      Parameters:
      swipeToOpen - the value for the swipe-to-open property
      Returns:
      the Builder instance is returned, to allow method chaining

    • setTransitionType

      @Deprecated public B setTransitionType(FlapTransitionType transitionType)
      Deprecated.
      See the migration guide

      the type of animation used for reveal and fold transitions.

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

      Parameters:
      transitionType - the value for the transition-type property
      Returns:
      the Builder instance is returned, to allow method chaining