SESL Material/com.google.android.material.floatingactionbutton/ExtendedFloatingActionButton

ExtendedFloatingActionButton

open class ExtendedFloatingActionButton : MaterialButton, CoordinatorLayout.AttachedBehavior

Extended floating action buttons are used for a special type of promoted action. They are distinguished by an icon and a text floating above the UI and have special motion behaviors related to morphing, launching, and the transferring anchor point.

Extended floating action buttons may have icon and text, but may also hold just an icon or text.

As this class descends from MaterialButton, you can control the icon which is displayed via setIcon, and the text via setText.

The background color of this view defaults to the your theme's colorSecondary. If you wish to change this at runtime then you can do so via setBackgroundTintList.

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

Constructors

Link copied to clipboard
constructor(@NonNull context: Context)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int)

Types

Link copied to clipboard
abstract class OnChangedCallback
Callback to be invoked when the visibility or the state of an ExtendedFloatingActionButton changes.

Properties

Link copied to clipboard
Link copied to clipboard
open var isExtended: Boolean

Functions

Link copied to clipboard
open fun addOnExtendAnimationListener(@NonNull listener: Animator.AnimatorListener)
Add a listener that will be invoked when this ExtendedFloatingActionButton is extended.
Link copied to clipboard
open fun addOnHideAnimationListener(@NonNull listener: Animator.AnimatorListener)
Add a listener that will be invoked when this ExtendedFloatingActionButton is hidden.
Link copied to clipboard
open fun addOnShowAnimationListener(@NonNull listener: Animator.AnimatorListener)
Add a listener that will be invoked when this ExtendedFloatingActionButton is shown.
Link copied to clipboard
open fun addOnShrinkAnimationListener(@NonNull listener: Animator.AnimatorListener)
Add a listener that will be invoked when this ExtendedFloatingActionButton is shrunk.
Link copied to clipboard
open fun extend()
open fun extend(@NonNull callback: ExtendedFloatingActionButton.OnChangedCallback)
Extends the FAB to show the text and the icon.
Link copied to clipboard
@Nullable
open fun getExtendMotionSpec(): MotionSpec
Returns the motion spec for the extend animation.
Link copied to clipboard
@Nullable
open fun getHideMotionSpec(): MotionSpec
Returns the motion spec for the hide animation.
Link copied to clipboard
@Nullable
open fun getShowMotionSpec(): MotionSpec
Returns the motion spec for the show animation.
Link copied to clipboard
@Nullable
open fun getShrinkMotionSpec(): MotionSpec
Returns the motion spec for the shrink animation.
Link copied to clipboard
open fun hide()
open fun hide(@NonNull callback: ExtendedFloatingActionButton.OnChangedCallback)
Hides the button.
Link copied to clipboard
open fun removeOnExtendAnimationListener(@NonNull listener: Animator.AnimatorListener)
Remove a listener that was previously added via addOnExtendAnimationListener.
Link copied to clipboard
open fun removeOnHideAnimationListener(@NonNull listener: Animator.AnimatorListener)
Remove a listener that was previously added via addOnHideAnimationListener.
Link copied to clipboard
open fun removeOnShowAnimationListener(@NonNull listener: Animator.AnimatorListener)
Remove a listener that was previously added via addOnShowAnimationListener.
Link copied to clipboard
open fun removeOnShrinkAnimationListener(@NonNull listener: Animator.AnimatorListener)
Remove a listener that was previously added via addOnShrinkAnimationListener.
Link copied to clipboard
open fun setAnimateShowBeforeLayout(animateShowBeforeLayout: Boolean)
Sets whether to enable animation for a call to show show even if the view has not been laid out yet.
Link copied to clipboard
open fun setExtendMotionSpec(@Nullable spec: MotionSpec)
Updates the motion spec for the extend animation.
Link copied to clipboard
open fun setExtendMotionSpecResource(@AnimatorRes id: Int)
Updates the motion spec for the extend animation.
Link copied to clipboard
open fun setHideMotionSpec(@Nullable spec: MotionSpec)
Updates the motion spec for the hide animation.
Link copied to clipboard
open fun setHideMotionSpecResource(@AnimatorRes id: Int)
Updates the motion spec for the hide animation.
Link copied to clipboard
open fun setPadding(left: Int, top: Int, right: Int, bottom: Int)
Link copied to clipboard
open fun setPaddingRelative(start: Int, top: Int, end: Int, bottom: Int)
Link copied to clipboard
open fun setShowMotionSpec(@Nullable spec: MotionSpec)
Updates the motion spec for the show animation.
Link copied to clipboard
open fun setShowMotionSpecResource(@AnimatorRes id: Int)
Updates the motion spec for the show animation.
Link copied to clipboard
open fun setShrinkMotionSpec(@Nullable spec: MotionSpec)
Updates the motion spec for the shrink animation.
Link copied to clipboard
open fun setShrinkMotionSpecResource(@AnimatorRes id: Int)
Updates the motion spec for the shrink animation.
Link copied to clipboard
open fun setTextColor(@NonNull colors: ColorStateList)
open fun setTextColor(color: Int)
Link copied to clipboard
open fun show()
open fun show(@NonNull callback: ExtendedFloatingActionButton.OnChangedCallback)
Shows the button.
Link copied to clipboard
open fun shrink()
open fun shrink(@NonNull callback: ExtendedFloatingActionButton.OnChangedCallback)
Shrinks the FAB to show just the icon.