SESL Material/com.google.android.material.snackbar/BaseTransientBottomBar

BaseTransientBottomBar

abstract class BaseTransientBottomBar<B : BaseTransientBottomBar<B>?>

Base class for lightweight transient bars that are displayed along the bottom edge of the application window.

Parameters

<B>

The transient bottom bar subclass.

Inheritors

Types

Link copied to clipboard
@RestrictTo(value = LIBRARY_GROUP)
@Retention(value = RetentionPolicy.SOURCE)
annotation class AnimationMode
Animation modes that can be set on the BaseTransientBottomBar.
Link copied to clipboard
abstract class BaseCallback<B>
Base class for BaseTransientBottomBar callbacks.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
interface ContentViewCallback : ContentViewCallback
Interface that defines the behavior of the main content of a transient bottom bar.
Link copied to clipboard
@RestrictTo(value = LIBRARY_GROUP)
@IntRange(from = -2)
@Retention(value = RetentionPolicy.SOURCE)
annotation class Duration

Properties

Link copied to clipboard
val ANIMATION_MODE_FADE: Int = 1
Animation mode that corresponds to the fade in and out animations.
Link copied to clipboard
val ANIMATION_MODE_SLIDE: Int = 0
Animation mode that corresponds to the slide in and out animations.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@set:NonNull
open var duration: Int
Link copied to clipboard
val LENGTH_INDEFINITE: Int = -2
Show the Snackbar indefinitely.
Link copied to clipboard
val LENGTH_LONG: Int = 0
Show the Snackbar for a long period of time.
Link copied to clipboard
val LENGTH_SHORT: Int = -1
Show the Snackbar for a short period of time.

Functions

Link copied to clipboard
@NonNull
open fun addCallback(@Nullable callback: BaseTransientBottomBar.BaseCallback<B>): B
Adds the specified callback to the list of callbacks that will be notified of transient bottom bar events.
Link copied to clipboard
open fun dismiss()
Dismiss the BaseTransientBottomBar.
Link copied to clipboard
@Nullable
open fun getAnchorView(): View
Returns the anchor view for this BaseTransientBottomBar.
Link copied to clipboard
open fun getAnimationMode(): Int
Returns the animation mode.
Link copied to clipboard
@NonNull
open fun getView(): View
Returns the BaseTransientBottomBar's view.
Link copied to clipboard
open fun isAnchorViewLayoutListenerEnabled(): Boolean
Returns whether the anchor view layout listener is enabled.
Link copied to clipboard
open fun isGestureInsetBottomIgnored(): Boolean
Returns whether this bottom bar should adjust it's position based on the system gesture area on Android Q and above.
Link copied to clipboard
open fun isShown(): Boolean
Return whether this BaseTransientBottomBar is currently being shown.
Link copied to clipboard
open fun isShownOrQueued(): Boolean
Returns whether this BaseTransientBottomBar is currently being shown, or is queued to be shown next.
Link copied to clipboard
@NonNull
open fun removeCallback(@Nullable callback: BaseTransientBottomBar.BaseCallback<B>): B
Removes the specified callback from the list of callbacks that will be notified of transient bottom bar events.
Link copied to clipboard
@NonNull
open fun setAnchorView(@Nullable anchorView: View): B
Sets the view the BaseTransientBottomBar should be anchored above.
@NonNull
open fun setAnchorView(@IdRes anchorViewId: Int): B
Sets the view the BaseTransientBottomBar should be anchored above by id.
Link copied to clipboard
open fun setAnchorViewLayoutListenerEnabled(anchorViewLayoutListenerEnabled: Boolean)
Sets whether the anchor view layout listener is enabled.
Link copied to clipboard
@NonNull
open fun setAnimationMode(animationMode: Int): B
Sets the animation mode.
Link copied to clipboard
@NonNull
open fun setGestureInsetBottomIgnored(gestureInsetBottomIgnored: Boolean): B
Sets whether this bottom bar should adjust it's position based on the system gesture area on Android Q and above.
Link copied to clipboard
open fun show()
Show the BaseTransientBottomBar.