1.12.0+1.0.31-sesl8+rev0

SESL Material/com.google.android.material.appbar/AppBarLayout

AppBarLayout

open class AppBarLayout : LinearLayout, CoordinatorLayout.AttachedBehavior, AppBarLayoutBehavior

(SESL Variant) AppBarLayout is a vertical LinearLayout which implements many of the features of material designs app bar concept, namely scrolling gestures.

Children should provide their desired scrolling behavior through setScrollFlags and the associated layout xml attribute: app:layout_scrollFlags.

This view depends heavily on being used as a direct child within a CoordinatorLayout. If you use AppBarLayout within a different ViewGroup, most of its functionality will not work.

AppBarLayout also requires a separate scrolling sibling in order to know when to scroll. The binding is done through the ScrollingViewBehavior behavior class, meaning that you should set your scrolling view's behavior to be an instance of ScrollingViewBehavior. A string resource containing the full class name is available.

<androidx.coordinatorlayout.widget.CoordinatorLayout
        xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:app="http://schemas.android.com/apk/res-auto"
        android:layout_width="match_parent"
        android:layout_height="match_parent">

    <androidx.core.widget.NestedScrollView
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            app:layout_behavior="@string/appbar_scrolling_view_behavior">

        <!-- Your scrolling content -->

    </androidx.core.widget.NestedScrollView>

    <com.google.android.material.appbar.AppBarLayout
            android:layout_height="wrap_content"
            android:layout_width="match_parent">

        <androidx.appcompat.widget.Toolbar
                ...
                app:layout_scrollFlags="scroll|enterAlways"/>

        <com.google.android.material.tabs.TabLayout
                ...
                app:layout_scrollFlags="scroll|enterAlways"/>

    </com.google.android.material.appbar.AppBarLayout>

</androidx.coordinatorlayout.widget.CoordinatorLayout>

For more information, see the component developer guidance and design guidelines.

Constructors

constructor(@NonNull context: Context)

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int)

Types

BaseOnOffsetChangedListener

interface BaseOnOffsetChangedListener<T : AppBarLayout?>

Interface definition for a callback to be invoked when an AppBarLayout's vertical offset changes.

open class Behavior : AppBarLayout.BaseBehavior<T>

The default Behavior for AppBarLayout.

ChildScrollEffect

abstract class ChildScrollEffect

An effect class that should be implemented and used by AppBarLayout children to be given effects when the AppBarLayout's offset changes.

CompressChildScrollEffect

open class CompressChildScrollEffect : AppBarLayout.ChildScrollEffect

A class which handles updating an AppBarLayout child, if marked with the


app:layout_scrollEffect

compress, at each step in the AppBarLayout's offset animation.

open class LayoutParams : LinearLayout.LayoutParams

A ViewGroup.LayoutParams implementation for AppBarLayout.

LiftOnScrollListener

interface LiftOnScrollListener

Definition for a callback to be invoked when the lift on scroll elevation and background color change.

OnOffsetChangedListener

interface OnOffsetChangedListener : AppBarLayout.BaseOnOffsetChangedListener<T>

Interface definition for a callback to be invoked when an AppBarLayout's vertical offset changes.

ScrollingViewBehavior

open class ScrollingViewBehavior : HeaderScrollingViewBehavior

Behavior which should be used by Views which can scroll vertically and support nested scrolling to automatically scroll any AppBarLayout siblings.

SeslAppbarState

open class SeslAppbarState

SeslBaseOnImmOffsetChangedListener

interface SeslBaseOnImmOffsetChangedListener<T : AppBarLayout?>

SeslOnImmOffsetChangedListener

interface SeslOnImmOffsetChangedListener : AppBarLayout.SeslBaseOnImmOffsetChangedListener<T>

Properties

IMMERSIVE_DETACH_OPTION_SET_FIT_SYSTEM_WINDOW

val IMMERSIVE_DETACH_OPTION_SET_FIT_SYSTEM_WINDOW: Int = 1

liftOnScrollTargetViewId

@get:IdRes

open var liftOnScrollTargetViewId: Int

SESL_STATE_COLLAPSED

val SESL_STATE_COLLAPSED: Int = 0

SESL_STATE_EXPANDED

val SESL_STATE_EXPANDED: Int = 1

SESL_STATE_HIDE

val SESL_STATE_HIDE: Int = 2

SESL_STATE_IDLE

val SESL_STATE_IDLE: Int = 3

statusBarForeground

open var statusBarForeground: Drawable

totalScrollRange

open val totalScrollRange: Int

Functions

addLiftOnScrollListener

open fun addLiftOnScrollListener(@NonNull liftOnScrollListener: AppBarLayout.LiftOnScrollListener)

Add a LiftOnScrollListener that will be called when the lift on scroll elevation and background color of this AppBarLayout change.

addOnOffsetChangedListener

open fun addOnOffsetChangedListener(@Nullable listener: AppBarLayout.BaseOnOffsetChangedListener)

Add a listener that will be called when the offset of this AppBarLayout changes.

open fun addOnOffsetChangedListener(listener: AppBarLayout.OnOffsetChangedListener)

clearLiftOnScrollListener

open fun clearLiftOnScrollListener()

Remove all previously added LiftOnScrollListeners.

dispatchGenericMotionEvent

open fun dispatchGenericMotionEvent(event: MotionEvent): Boolean

open fun draw(@NonNull canvas: Canvas)

generateLayoutParams

open fun generateLayoutParams(attrs: AttributeSet): AppBarLayout.LayoutParams

open fun getBehavior(): CoordinatorLayout.Behavior<AppBarLayout>

getMaterialShapeBackground

open fun getMaterialShapeBackground(): MaterialShapeDrawable

getMinimumHeightForVisibleOverlappingContent

fun getMinimumHeightForVisibleOverlappingContent(): Int

getTargetElevation

open fun ~~getTargetElevation~~(): Float

open fun isLifted(): Boolean

Returns whether the AppBarLayout is in a lifted state or not.

open fun isLiftOnScroll(): Boolean

Returns whether the AppBarLayout lifts on scroll or not.

removeLiftOnScrollListener

open fun removeLiftOnScrollListener(@NonNull liftOnScrollListener: AppBarLayout.LiftOnScrollListener): Boolean

Remove a previously added LiftOnScrollListener.

removeOnOffsetChangedListener

open fun removeOnOffsetChangedListener(@Nullable listener: AppBarLayout.BaseOnOffsetChangedListener)

Remove the previously added OnOffsetChangedListener.

open fun removeOnOffsetChangedListener(listener: AppBarLayout.OnOffsetChangedListener)

resetAppBarAndInsets

@RequiresApi(api = VERSION_CODES.R)

open fun resetAppBarAndInsets()

seslActivateImmersiveScroll

@RequiresApi(api = VERSION_CODES.R)

open fun seslActivateImmersiveScroll(activate: Boolean)

@RequiresApi(api = VERSION_CODES.R)

open fun seslActivateImmersiveScroll(activate: Boolean, restoreAnim: Boolean)

seslAddOnImmOffsetChangedListener

open fun seslAddOnImmOffsetChangedListener(@Nullable listener: AppBarLayout.SeslBaseOnImmOffsetChangedListener)

open fun seslAddOnImmOffsetChangedListener(listener: AppBarLayout.SeslOnImmOffsetChangedListener)

seslCancelWindowInsetsAnimationController

@RequiresApi(api = VERSION_CODES.R)

open fun seslCancelWindowInsetsAnimationController()

seslCanImmersiveScroll

@RequiresApi(api = 30)

open fun seslCanImmersiveScroll(): Boolean

seslGetAppBarState

open fun seslGetAppBarState(): AppBarLayout.SeslAppbarState

seslGetCollapsedHeight

open fun seslGetCollapsedHeight(): Float

seslGetHeightProPortion

open fun seslGetHeightProPortion(): Float

seslGetImmersiveScroll

open fun seslGetImmersiveScroll(): Boolean

seslHaveImmersiveBehavior

open fun seslHaveImmersiveBehavior(): Boolean

seslImmHideStatusBarForLandscape

open fun seslImmHideStatusBarForLandscape(hide: Boolean)

seslIsActivatedImmsersiveScroll

open fun seslIsActivatedImmsersiveScroll(): Boolean

seslIsCollapsed

open fun seslIsCollapsed(): Boolean

seslRemoveOnImmOffsetChangedListener

open fun seslRemoveOnImmOffsetChangedListener(listener: AppBarLayout.OnOffsetChangedListener)

open fun seslRemoveOnImmOffsetChangedListener(listener: AppBarLayout.SeslBaseOnImmOffsetChangedListener)

seslReserveImmersiveDetachOption

@RequiresApi(value = 30)

open fun seslReserveImmersiveDetachOption(flag: Int)

seslResetAppBarAndInsets

@RequiresApi(api = VERSION_CODES.R)

open fun seslResetAppBarAndInsets(force: Boolean)

seslRestoreTopAndBottom

@RequiresApi(api = VERSION_CODES.R)

open fun seslRestoreTopAndBottom()

@RequiresApi(api = VERSION_CODES.R)

open fun ~~seslRestoreTopAndBottom~~(view: View)

@RequiresApi(api = VERSION_CODES.R)

open fun seslRestoreTopAndBottom(restore: Boolean)

seslSetAutoRestoreTopAndBottom

@RequiresApi(api = VERSION_CODES.R)

open fun seslSetAutoRestoreTopAndBottom(autorestore: Boolean)

seslSetBottomView

@RequiresApi(api = VERSION_CODES.R)

open fun seslSetBottomView(bottomView: View)

@RequiresApi(api = VERSION_CODES.R)

open fun ~~seslSetBottomView~~(view: View, bottomView: View)

seslSetCollapsedHeight

open fun seslSetCollapsedHeight(height: Float)

seslSetCustomHeight

open fun seslSetCustomHeight(height: Int)

seslSetCustomHeightProportion

open fun seslSetCustomHeightProportion(enabled: Boolean, @FloatRange(from = 0, to = 1) proportion: Float)

seslSetExpanded

open fun seslSetExpanded(expanded: Boolean)

seslSetImmersiveScroll

@RequiresApi(api = VERSION_CODES.R)

open fun seslSetImmersiveScroll(activate: Boolean)

@RequiresApi(api = VERSION_CODES.R)

open fun seslSetImmersiveScroll(activate: Boolean, byUser: Boolean)

open fun seslSetIsMouse(isMouse: Boolean)

seslSetNeedToCheckBottomViewMargin

@RequiresApi(api = VERSION_CODES.R)

open fun seslSetNeedToCheckBottomViewMargin(checkBottomViewMargin: Boolean)

seslSetSuggestion

open fun seslSetSuggestion(hasSuggestion: Boolean)

seslSetTCScrollRange

open fun seslSetTCScrollRange(range: Int)

seslSetWindowInsetsAnimationCallback

open fun seslSetWindowInsetsAnimationCallback(callback: Any)

@RequiresApi(value = VERSION_CODES.LOLLIPOP)

open fun setElevation(elevation: Float)

open fun setExpanded(expanded: Boolean)

Sets whether this AppBarLayout is expanded or not, animating if it has already been laid out.

open fun setExpanded(expanded: Boolean, animate: Boolean)

Sets whether this AppBarLayout is expanded or not.

open fun setLiftable(liftable: Boolean): Boolean

Sets whether the AppBarLayout is liftable or not.

setLiftableOverrideEnabled

open fun setLiftableOverrideEnabled(enabled: Boolean)

Sets whether the AppBarLayout lifted state corresponding to setLiftable and setLifted will be overridden manually.

open fun setLifted(lifted: Boolean): Boolean

Sets whether the AppBarLayout is in a lifted state or not.

setLiftOnScroll

open fun setLiftOnScroll(liftOnScroll: Boolean)

Sets whether the AppBarLayout lifts on scroll or not.

setLiftOnScrollTargetView

open fun setLiftOnScrollTargetView(@Nullable liftOnScrollTargetView: View)

Sets the view that the AppBarLayout should use to determine whether it should be lifted.

open fun setOrientation(orientation: Int)

setStatusBarForegroundColor

open fun setStatusBarForegroundColor(@ColorInt color: Int)

Set the color to use for the status bar foreground.

setStatusBarForegroundResource

open fun setStatusBarForegroundResource(@DrawableRes resId: Int)

Set the drawable to use for the status bar foreground from resources.

setTargetElevation

open fun ~~setTargetElevation~~(elevation: Float)

open fun setVisibility(visibility: Int)