CollapsingToolbarLayout.LayoutParams

public static class CollapsingToolbarLayout.LayoutParams
extends FrameLayout.LayoutParams

java.lang.Object
↳	android.view.ViewGroup.LayoutParams
	↳	android.view.ViewGroup.MarginLayoutParams
		↳	android.widget.FrameLayout.LayoutParams
			↳	com.google.android.material.appbar.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
`LayoutParams(Context c, AttributeSet attrs)`
`LayoutParams(int width, int height)`
`LayoutParams(int width, int height, int gravity)`
`LayoutParams(ViewGroup.LayoutParams p)`
`LayoutParams(ViewGroup.MarginLayoutParams source)`
`LayoutParams(FrameLayout.LayoutParams source)`
`LayoutParams(CollapsingToolbarLayout.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

public static final int COLLAPSE_MODE_OFF

The view will act as normal with no collapsing behavior.

Constant Value: 0 (0x00000000)

COLLAPSE_MODE_PARALLAX

public static final 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

public static final int COLLAPSE_MODE_PIN

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

Constant Value: 1 (0x00000001)

Public constructors

LayoutParams

public LayoutParams (Context c, 
                AttributeSet attrs)

Parameters
`c`	`Context`
`attrs`	`AttributeSet`

LayoutParams

public LayoutParams (int width, 
                int height)

Parameters
`width`	`int`
`height`	`int`

LayoutParams

public LayoutParams (int width, 
                int height, 
                int gravity)

Parameters
`width`	`int`
`height`	`int`
`gravity`	`int`

LayoutParams

public LayoutParams (ViewGroup.LayoutParams p)

Parameters
`p`	`ViewGroup.LayoutParams`

LayoutParams

public LayoutParams (ViewGroup.MarginLayoutParams source)

Parameters
`source`	`ViewGroup.MarginLayoutParams`

public LayoutParams (FrameLayout.LayoutParams source)

Parameters
`source`	`FrameLayout.LayoutParams`

LayoutParams

public LayoutParams (CollapsingToolbarLayout.LayoutParams source)

Parameters
`source`	`CollapsingToolbarLayout.LayoutParams`

Public methods

getCollapseMode

public 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

public float getParallaxMultiplier ()

Returns the parallax scroll multiplier used in conjunction with COLLAPSE_MODE_PARALLAX.

Returns
`float`

See also:

setParallaxMultiplier(float)

setCollapseMode

public void setCollapseMode (int collapseMode)

Set the collapse mode.

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

setParallaxMultiplier

public 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()