SESL Material/com.google.android.material.oneui.floatingdock/FloatingPaneLayout

FloatingPaneLayout

class FloatingPaneLayout @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0, defStyleRes: Int = 0) : FrameLayout

A layout that allows a child view to be displayed as a floating pane that can be moved, resized, docked, or minimized.

It provides functionality for:

Displaying a child view as a floating pane.
Moving and resizing the floating pane.
Docking the floating pane to the sides or bottom of the screen.
Minimizing the floating pane to an icon.
Showing a pre-docking effect when the pane is dragged near a docking area.
Applying a blur effect to the background behind the pane (if supported).

To use FloatingPaneLayout, add it to your layout XML and then add your content view with the ID R.id.result_layout_content. You can optionally add a minimized view with the ID R.id.result_layout_minimize.

Example usage:

<com.google.android.material.oneui.floatingdock.FloatingPaneLayout
    android:id="@+id/floating_pane_layout"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <FrameLayout
        android:id="@id/result_layout_content"
        android:layout_width="300dp"
        android:layout_height="400dp"
        android:background="@android:color/white">
        <!-- Your content view here -->
    </FrameLayout>

    <ImageView
        android:id="@id/result_layout_minimize"
        android:layout_width="48dp"
        android:layout_height="48dp"
        android:src="@drawable/ic_minimize_icon" />

</com.google.android.material.oneui.floatingdock.FloatingPaneLayout>

You can control the behavior of the floating pane using methods like show(), hide(), enterMinimizeView(), and setAllowModes(). Callbacks can be registered via addCallback() to listen to pane state changes.

Parameters

context

The Context the view is running in, through which it can

Constructors

FloatingPaneLayout

@JvmOverloads

constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0, defStyleRes: Int = 0)

Types

Companion

object Companion

Functions

addCallback

fun addCallback(@NotNull callback: IFloatingPaneCallback)

Adds a callback to be notified of floating pane events.

addUntouchableAreaInset

fun addUntouchableAreaInset(left: Int, top: Int, right: Int, bottom: Int)

Sets an untouchable area inset for the floating pane when it's in floating mode. This allows defining a region around the floating pane where touch events will be ignored.

addView

open override fun addView(child: View)

open override fun addView(child: View, params: ViewGroup.LayoutParams)

open override fun addView(child: View, index: Int)

open override fun addView(child: View, index: Int, params: ViewGroup.LayoutParams)

open override fun addView(child: View, width: Int, height: Int)

enterMinimizeView

fun enterMinimizeView(minimize: Boolean)

Enters or exits the minimized view state for the floating pane.

getPaneMode

fun getPaneMode(): FloatingPane.FloatingPaneMode

Retrieves the current mode of the floating pane.

getTopLimitSize

fun getTopLimitSize(): Int

Retrieves the top limit size for the floating pane. This value typically corresponds to the height of the status bar or a similar top UI element, preventing the floating pane from overlapping with it.

hide

@JvmOverloads

fun hide(animate: Boolean = true)

Hides the floating pane.

isMinimizeView

fun isMinimizeView(): Boolean

isShowing

fun isShowing(): Boolean

Checks if the floating pane is currently showing.

onLayout