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

Summary: Constants | Inherited Constants | Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

CollapsingToolbarLayout.LayoutParams

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 CollapsingToolbarLayout.LayoutParams
extends FrameLayout.LayoutParams

java.lang.Object
↳	android.view.ViewGroup.LayoutParams
	↳	android.view.ViewGroup.MarginLayoutParams
		↳	android.widget.FrameLayout.LayoutParams
			↳	android.support.design.widget.CollapsingToolbarLayout.LayoutParams

---

Summary

Constants
int	COLLAPSE_MODE_OFF The view will act as normal with no collapsing behavior.
int	COLLAPSE_MODE_PARALLAX The view will scroll in a parallax fashion.
int	COLLAPSE_MODE_PIN The view will pin in place until it reaches the bottom of the CollapsingToolbarLayout.

Inherited constants
From class android.widget.FrameLayout.LayoutParams int UNSPECIFIED_GRAVITY
From class android.view.ViewGroup.LayoutParams int FILL_PARENT int MATCH_PARENT int WRAP_CONTENT

Inherited fields
From class android.widget.FrameLayout.LayoutParams public int gravity
From class android.view.ViewGroup.MarginLayoutParams public int bottomMargin public int leftMargin public int rightMargin public int topMargin
From class android.view.ViewGroup.LayoutParams public int height public LayoutAnimationController.AnimationParameters layoutAnimationParameters public int width

Public constructors
CollapsingToolbarLayout.LayoutParams(Context c, AttributeSet attrs)
CollapsingToolbarLayout.LayoutParams(int width, int height)
CollapsingToolbarLayout.LayoutParams(int width, int height, int gravity)
CollapsingToolbarLayout.LayoutParams(ViewGroup.LayoutParams p)
CollapsingToolbarLayout.LayoutParams(ViewGroup.MarginLayoutParams source)
CollapsingToolbarLayout.LayoutParams(FrameLayout.LayoutParams source)

Public methods
int	getCollapseMode() Returns the requested collapse mode.
float	getParallaxMultiplier() Returns the parallax scroll multiplier used in conjunction with COLLAPSE_MODE_PARALLAX.
void	setCollapseMode(int collapseMode) Set the collapse mode.
void	setParallaxMultiplier(float multiplier) Set the parallax scroll multiplier used in conjunction with COLLAPSE_MODE_PARALLAX.

Inherited methods
From class android.view.ViewGroup.MarginLayoutParams int getLayoutDirection() int getMarginEnd() int getMarginStart() boolean isMarginRelative() void resolveLayoutDirection(int arg0) void setLayoutDirection(int arg0) void setMarginEnd(int arg0) void setMarginStart(int arg0) void setMargins(int arg0, int arg1, int arg2, int arg3)
From class android.view.ViewGroup.LayoutParams void resolveLayoutDirection(int arg0) void setBaseAttributes(TypedArray arg0, int arg1, int arg2)
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()

Constants

COLLAPSE_MODE_OFF

added in version 22.2.0

int COLLAPSE_MODE_OFF

The view will act as normal with no collapsing behavior.

Constant Value: 0 (0x00000000)

COLLAPSE_MODE_PARALLAX

added in version 22.2.0

int COLLAPSE_MODE_PARALLAX

The view will scroll in a parallax fashion. See setParallaxMultiplier(float) to change the multiplier used.

Constant Value: 2 (0x00000002)

COLLAPSE_MODE_PIN

added in version 22.2.0

int COLLAPSE_MODE_PIN

The view will pin in place until it reaches the bottom of the CollapsingToolbarLayout.

Constant Value: 1 (0x00000001)

Public constructors

CollapsingToolbarLayout.LayoutParams

added in version 22.2.0

CollapsingToolbarLayout.LayoutParams (Context c, 
                AttributeSet attrs)

Parameters
c	Context
attrs	AttributeSet

CollapsingToolbarLayout.LayoutParams

added in version 22.2.0

CollapsingToolbarLayout.LayoutParams (int width, 
                int height)

Parameters
width	int
height	int

CollapsingToolbarLayout.LayoutParams

added in version 22.2.0

CollapsingToolbarLayout.LayoutParams (int width, 
                int height, 
                int gravity)

Parameters
width	int
height	int
gravity	int

CollapsingToolbarLayout.LayoutParams

added in version 22.2.0

CollapsingToolbarLayout.LayoutParams (ViewGroup.LayoutParams p)

Parameters
p	ViewGroup.LayoutParams

CollapsingToolbarLayout.LayoutParams

added in version 22.2.0

CollapsingToolbarLayout.LayoutParams (ViewGroup.MarginLayoutParams source)

Parameters
source	ViewGroup.MarginLayoutParams

CollapsingToolbarLayout.LayoutParams

added in version 22.2.0

CollapsingToolbarLayout.LayoutParams (FrameLayout.LayoutParams source)

Parameters
source	FrameLayout.LayoutParams

Public methods

getCollapseMode

added in version 22.2.0

int getCollapseMode ()

Returns the requested collapse mode.

Returns
int	the current mode. One of COLLAPSE_MODE_OFF, COLLAPSE_MODE_PIN or COLLAPSE_MODE_PARALLAX.

getParallaxMultiplier

added in version 22.2.0

float getParallaxMultiplier ()

Returns the parallax scroll multiplier used in conjunction with COLLAPSE_MODE_PARALLAX.

Returns
float

See also:

• setParallaxMultiplier(float)

setCollapseMode

added in version 22.2.0

void setCollapseMode (int collapseMode)

Set the collapse mode.

Parameters
collapseMode	int: one of COLLAPSE_MODE_OFF, COLLAPSE_MODE_PIN or COLLAPSE_MODE_PARALLAX.

setParallaxMultiplier

added in version 22.2.0

void setParallaxMultiplier (float multiplier)

Set the parallax scroll multiplier used in conjunction with COLLAPSE_MODE_PARALLAX. A value of 0.0 indicates no movement at all, 1.0f indicates normal scroll movement.

Parameters
multiplier	float: the multiplier.

See also:

• getParallaxMultiplier()

• 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