added in version 22.2.0
belongs to Maven artifact com.android.support:design:27.1.0

Summary: XML Attrs | Ctors | Methods | Inherited Methods | [Expand All]

FloatingActionButton.Behavior

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public static class FloatingActionButton.Behavior
extends Behavior<FloatingActionButton>

java.lang.Object
↳	android.support.design.widget.CoordinatorLayout.Behavior<android.support.design.widget.FloatingActionButton>
	↳	android.support.design.widget.FloatingActionButton.Behavior

---

Behavior designed for use with FloatingActionButton instances. Its main function is to move FloatingActionButton views so that any displayed Snackbars do not cover them.

Summary

XML attributes
FloatingActionButton_Behavior_Layout_behavior_autoHide

Public constructors
FloatingActionButton.Behavior()
FloatingActionButton.Behavior(Context context, AttributeSet attrs)

Public methods
boolean	getInsetDodgeRect(CoordinatorLayout parent, FloatingActionButton child, Rect rect) Called when a view is set to dodge view insets.
boolean	isAutoHideEnabled() Returns whether the associated FloatingActionButton automatically hides when there is not enough space to be displayed.
void	onAttachedToLayoutParams(CoordinatorLayout.LayoutParams lp) Called when the Behavior has been attached to a LayoutParams instance.
boolean	onDependentViewChanged(CoordinatorLayout parent, FloatingActionButton child, View dependency) Respond to a change in a child's dependent view This method is called whenever a dependent view changes in size or position outside of the standard layout flow.
boolean	onLayoutChild(CoordinatorLayout parent, FloatingActionButton child, int layoutDirection) Called when the parent CoordinatorLayout is about the lay out the given child view.
void	setAutoHideEnabled(boolean autoHide) Sets whether the associated FloatingActionButton automatically hides when there is not enough space to be displayed.

Inherited methods
From class android.support.design.widget.CoordinatorLayout.Behavior boolean blocksInteractionBelow(CoordinatorLayout parent, V child) Determine whether interaction with views behind the given child in the child order should be blocked. boolean getInsetDodgeRect(CoordinatorLayout parent, V child, Rect rect) Called when a view is set to dodge view insets. int getScrimColor(CoordinatorLayout parent, V child) Supply a scrim color that will be painted behind the associated child view. float getScrimOpacity(CoordinatorLayout parent, V child) Determine the current opacity of the scrim behind a given child view A scrim may be used to indicate that the other elements beneath it are not currently interactive or actionable, drawing user focus and attention to the views above the scrim. static Object getTag(View child) Get the behavior-specific tag object with the given child view. boolean layoutDependsOn(CoordinatorLayout parent, V child, View dependency) Determine whether the supplied child view has another specific sibling view as a layout dependency. WindowInsetsCompat onApplyWindowInsets(CoordinatorLayout coordinatorLayout, V child, WindowInsetsCompat insets) Called when the window insets have changed. void onAttachedToLayoutParams(CoordinatorLayout.LayoutParams params) Called when the Behavior has been attached to a LayoutParams instance. boolean onDependentViewChanged(CoordinatorLayout parent, V child, View dependency) Respond to a change in a child's dependent view This method is called whenever a dependent view changes in size or position outside of the standard layout flow. void onDependentViewRemoved(CoordinatorLayout parent, V child, View dependency) Respond to a child's dependent view being removed. void onDetachedFromLayoutParams() Called when the Behavior has been detached from its holding LayoutParams instance. boolean onInterceptTouchEvent(CoordinatorLayout parent, V child, MotionEvent ev) Respond to CoordinatorLayout touch events before they are dispatched to child views. boolean onLayoutChild(CoordinatorLayout parent, V child, int layoutDirection) Called when the parent CoordinatorLayout is about the lay out the given child view. boolean onMeasureChild(CoordinatorLayout parent, V child, int parentWidthMeasureSpec, int widthUsed, int parentHeightMeasureSpec, int heightUsed) Called when the parent CoordinatorLayout is about to measure the given child view. boolean onNestedFling(CoordinatorLayout coordinatorLayout, V child, View target, float velocityX, float velocityY, boolean consumed) Called when a nested scrolling child is starting a fling or an action that would be a fling. boolean onNestedPreFling(CoordinatorLayout coordinatorLayout, V child, View target, float velocityX, float velocityY) Called when a nested scrolling child is about to start a fling. void onNestedPreScroll(CoordinatorLayout coordinatorLayout, V child, View target, int dx, int dy, int[] consumed) This method was deprecated in API level 26.1.0. You should now override onNestedPreScroll(CoordinatorLayout, View, View, int, int, int[], int). This method will still continue to be called if the type is TYPE_TOUCH. void onNestedPreScroll(CoordinatorLayout coordinatorLayout, V child, View target, int dx, int dy, int[] consumed, int type) Called when a nested scroll in progress is about to update, before the target has consumed any of the scrolled distance. void onNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed) This method was deprecated in API level 26.1.0. You should now override onNestedScroll(CoordinatorLayout, View, View, int, int, int, int, int). This method will still continue to be called if the type is TYPE_TOUCH. void onNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int type) Called when a nested scroll in progress has updated and the target has scrolled or attempted to scroll. void onNestedScrollAccepted(CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int axes, int type) Called when a nested scroll has been accepted by the CoordinatorLayout. void onNestedScrollAccepted(CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int axes) This method was deprecated in API level 26.1.0. You should now override onNestedScrollAccepted(CoordinatorLayout, View, View, View, int, int). This method will still continue to be called if the type is TYPE_TOUCH. boolean onRequestChildRectangleOnScreen(CoordinatorLayout coordinatorLayout, V child, Rect rectangle, boolean immediate) Called when a child of the view associated with this behavior wants a particular rectangle to be positioned onto the screen. void onRestoreInstanceState(CoordinatorLayout parent, V child, Parcelable state) Hook allowing a behavior to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(CoordinatorLayout, V). Parcelable onSaveInstanceState(CoordinatorLayout parent, V child) Hook allowing a behavior to generate a representation of its internal state that can later be used to create a new instance with that same state. boolean onStartNestedScroll(CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int axes) This method was deprecated in API level 26.1.0. You should now override onStartNestedScroll(CoordinatorLayout, View, View, View, int, int). This method will still continue to be called if the type is TYPE_TOUCH. boolean onStartNestedScroll(CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int axes, int type) Called when a descendant of the CoordinatorLayout attempts to initiate a nested scroll. void onStopNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target) This method was deprecated in API level 26.1.0. You should now override onStopNestedScroll(CoordinatorLayout, View, View, int). This method will still continue to be called if the type is TYPE_TOUCH. void onStopNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target, int type) Called when a nested scroll has ended. boolean onTouchEvent(CoordinatorLayout parent, V child, MotionEvent ev) Respond to CoordinatorLayout touch events after this Behavior has started intercepting them. static void setTag(View child, Object tag) Associate a Behavior-specific tag object with the given child view.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

XML attributes

FloatingActionButton_Behavior_Layout_behavior_autoHide

Related methods:

• setAutoHideEnabled(boolean)

Public constructors

FloatingActionButton.Behavior

added in version 22.2.0

FloatingActionButton.Behavior ()

FloatingActionButton.Behavior

added in version 26.1.0

FloatingActionButton.Behavior (Context context, 
                AttributeSet attrs)

Parameters
context	Context
attrs	AttributeSet

Public methods

getInsetDodgeRect

added in version 26.1.0

boolean getInsetDodgeRect (CoordinatorLayout parent, 
                FloatingActionButton child, 
                Rect rect)

Called when a view is set to dodge view insets.

This method allows a behavior to update the rectangle that should be dodged. The rectangle should be in the parent's coordinate system and within the child's bounds. If not, a IllegalArgumentException is thrown.

Parameters
parent	CoordinatorLayout: the CoordinatorLayout parent of the view this Behavior is associated with
child	FloatingActionButton: the child view of the CoordinatorLayout this Behavior is associated with
rect	Rect: the rect to update with the dodge rectangle

Returns
boolean	true the rect was updated, false if we should use the child's bounds

isAutoHideEnabled

added in version 26.1.0

boolean isAutoHideEnabled ()

Returns whether the associated FloatingActionButton automatically hides when there is not enough space to be displayed.

Related XML Attributes:

• FloatingActionButton_Behavior_Layout_behavior_autoHide

Returns
boolean	true if enabled

onAttachedToLayoutParams

added in version 26.1.0

void onAttachedToLayoutParams (CoordinatorLayout.LayoutParams lp)

Called when the Behavior has been attached to a LayoutParams instance.

This will be called after the LayoutParams has been instantiated and can be modified.

Parameters
lp	CoordinatorLayout.LayoutParams: the LayoutParams instance that this Behavior has been attached to

onDependentViewChanged

added in version 22.2.0

boolean onDependentViewChanged (CoordinatorLayout parent, 
                FloatingActionButton child, 
                View dependency)

Respond to a change in a child's dependent view

This method is called whenever a dependent view changes in size or position outside of the standard layout flow. A Behavior may use this method to appropriately update the child view in response.

A view's dependency is determined by layoutDependsOn(CoordinatorLayout, View, View) or if child has set another view as it's anchor.

Note that if a Behavior changes the layout of a child via this method, it should also be able to reconstruct the correct position in onLayoutChild. onDependentViewChanged will not be called during normal layout since the layout of each child view will always happen in dependency order.

If the Behavior changes the child view's size or position, it should return true. The default implementation returns false.

Parameters
parent	CoordinatorLayout: the parent view of the given child
child	FloatingActionButton: the child view to manipulate
dependency	View: the dependent view that changed

Returns
boolean	true if the Behavior changed the child view's size or position, false otherwise

onLayoutChild

added in version 23.4.0

boolean onLayoutChild (CoordinatorLayout parent, 
                FloatingActionButton child, 
                int layoutDirection)

Called when the parent CoordinatorLayout is about the lay out the given child view.

This method can be used to perform custom or modified layout of a child view in place of the default child layout behavior. The Behavior's implementation can delegate to the standard CoordinatorLayout measurement behavior by calling parent.onLayoutChild.

If a Behavior implements onDependentViewChanged(CoordinatorLayout, View, View) to change the position of a view in response to a dependent view changing, it should also implement onLayoutChild in such a way that respects those dependent views. onLayoutChild will always be called for a dependent view after its dependency has been laid out.

Parameters
parent	CoordinatorLayout: the parent CoordinatorLayout
child	FloatingActionButton: child view to lay out
layoutDirection	int: the resolved layout direction for the CoordinatorLayout, such as LAYOUT_DIRECTION_LTR or LAYOUT_DIRECTION_RTL.

Returns
boolean	true if the Behavior performed layout of the child view, false to request default layout behavior

setAutoHideEnabled

added in version 26.1.0

void setAutoHideEnabled (boolean autoHide)

Sets whether the associated FloatingActionButton automatically hides when there is not enough space to be displayed. This works with AppBarLayout and BottomSheetBehavior.

Related XML Attributes:

• FloatingActionButton_Behavior_Layout_behavior_autoHide

Parameters
autoHide	boolean: true to enable automatic hiding

• Annotations

  • CoordinatorLayout.DefaultBehavior

• Interfaces

  • AppBarLayout.OnOffsetChangedListener
  • BaseTransientBottomBar.ContentViewCallback
  • BottomNavigationView.OnNavigationItemReselectedListener
  • BottomNavigationView.OnNavigationItemSelectedListener
  • CoordinatorLayout.AttachedBehavior
  • NavigationView.OnNavigationItemSelectedListener
  • SwipeDismissBehavior.OnDismissListener
  • TabLayout.OnTabSelectedListener

• Classes

  • AppBarLayout
  • AppBarLayout.Behavior
  • AppBarLayout.Behavior.DragCallback
  • AppBarLayout.Behavior.SavedState
  • AppBarLayout.LayoutParams
  • AppBarLayout.ScrollingViewBehavior
  • BaseTransientBottomBar
  • BaseTransientBottomBar.BaseCallback
  • BottomNavigationView
  • BottomSheetBehavior
  • BottomSheetBehavior.BottomSheetCallback
  • BottomSheetBehavior.SavedState
  • BottomSheetDialog
  • BottomSheetDialogFragment
  • CollapsingToolbarLayout
  • CollapsingToolbarLayout.LayoutParams
  • CoordinatorLayout
  • CoordinatorLayout.Behavior
  • CoordinatorLayout.LayoutParams
  • CoordinatorLayout.SavedState
  • FloatingActionButton
  • FloatingActionButton.Behavior
  • FloatingActionButton.OnVisibilityChangedListener
  • NavigationView
  • NavigationView.SavedState
  • Snackbar
  • Snackbar.Callback
  • SwipeDismissBehavior
  • TabItem
  • TabLayout
  • TabLayout.Tab
  • TabLayout.TabLayoutOnPageChangeListener
  • TabLayout.ViewPagerOnTabSelectedListener
  • TextInputEditText
  • TextInputLayout