Skip to content

Most visited

Recently visited

navigation

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
         ↳ android.support.design.widget.CollapsingToolbarLayout.LayoutParams


Summary

Inherited XML attributes

From class android.widget.FrameLayout.LayoutParams
From class android.view.ViewGroup.MarginLayoutParams
From class android.view.ViewGroup.LayoutParams

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
From class android.view.ViewGroup.LayoutParams

Inherited fields

From class android.widget.FrameLayout.LayoutParams
From class android.view.ViewGroup.MarginLayoutParams
From class android.view.ViewGroup.LayoutParams

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
From class android.view.ViewGroup.LayoutParams
From class java.lang.Object

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:

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:

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.