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

Inherited fields

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)

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

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

LayoutParams

public LayoutParams (FrameLayout.LayoutParams source)

Parameters
source FrameLayout.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

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.