# CollapsingToolbarLayout.LayoutParams

[View Source](https://github.com/material-components/material-components-android/blob/1.14.0/lib/java/com/google/android/material/appbar/CollapsingToolbarLayout.java)

*** ** * ** ***


```
public class CollapsingToolbarLayout.LayoutParams
```

<br />

*** ** * ** ***

## Summary

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#COLLAPSE_MODE_OFF() = 0` The view will act as normal with no collapsing behavior. |
| `static final int` | `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#COLLAPSE_MODE_PARALLAX() = 2` The view will scroll in a parallax fashion. |
| `static final int` | `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#COLLAPSE_MODE_PIN() = 1` The view will pin in place until it reaches the bottom of the `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout`. |

| ### Public fields |
|---|---|
| `int` | `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#collapseMode()` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#LayoutParams(ViewGroup.LayoutParams)(LayoutParams p)` |
| `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#LayoutParams(com.google.android.material.appbar.CollapsingToolbarLayout.LayoutParams)(https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams source)` |
| `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#LayoutParams(FrameLayout.LayoutParams)(LayoutParams source)` |
| `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#LayoutParams(MarginLayoutParams)(MarginLayoutParams source)` |
| `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#LayoutParams(Context,AttributeSet)(Context c, AttributeSet attrs)` |
| `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#LayoutParams(int,int)(int width, int height)` |
| `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#LayoutParams(int,int,int)(int width, int height, int gravity)` |

| ### Public methods |
|---|---|
| `int` | `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#getCollapseMode()()` Returns the requested collapse mode. |
| `float` | `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#getParallaxMultiplier()()` Returns the parallax scroll multiplier used in conjunction with `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#COLLAPSE_MODE_PARALLAX()`. |
| `void` | `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#setCollapseMode(int)(int collapseMode)` Set the collapse mode. |
| `void` | `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#setParallaxMultiplier(float)(float multiplier)` Set the parallax scroll multiplier used in conjunction with `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#COLLAPSE_MODE_PARALLAX()`. |

## Constants

### COLLAPSE_MODE_OFF

```
public static final int COLLAPSE_MODE_OFF = 0
```

The view will act as normal with no collapsing behavior.

### COLLAPSE_MODE_PARALLAX

```
public static final int COLLAPSE_MODE_PARALLAX = 2
```

The view will scroll in a parallax fashion. See `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#setParallaxMultiplier(float)` to change the multiplier used.

### COLLAPSE_MODE_PIN

```
public static final int COLLAPSE_MODE_PIN = 1
```

The view will pin in place until it reaches the bottom of the `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout`.

## Public fields

### collapseMode

```
public int collapseMode
```

## Public constructors

### LayoutParams

```
public LayoutParams(LayoutParams p)
```

### LayoutParams

```
public LayoutParams(CollapsingToolbarLayout.LayoutParams source)
```

### LayoutParams

```
public LayoutParams(LayoutParams source)
```

### LayoutParams

```
public LayoutParams(MarginLayoutParams source)
```

### LayoutParams

```
public LayoutParams(Context c, AttributeSet attrs)
```

### LayoutParams

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

### LayoutParams

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

## Public methods

### getCollapseMode

```
public int getCollapseMode()
```

Returns the requested collapse mode.

| Returns |
|---|---|
| `int` | the current mode. One of `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#COLLAPSE_MODE_OFF()`, `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#COLLAPSE_MODE_PIN()` or `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#COLLAPSE_MODE_PARALLAX()`. |

### getParallaxMultiplier

```
public float getParallaxMultiplier()
```

Returns the parallax scroll multiplier used in conjunction with `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#COLLAPSE_MODE_PARALLAX()`.

| See also |
|---|---|
| `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#setParallaxMultiplier(float)` |   |

### setCollapseMode

```
public void setCollapseMode(int collapseMode)
```

Set the collapse mode.

| Parameters |
|---|---|
| `int collapseMode` | one of `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#COLLAPSE_MODE_OFF()`, `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#COLLAPSE_MODE_PIN()` or `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#COLLAPSE_MODE_PARALLAX()`. |

### setParallaxMultiplier

```
public void setParallaxMultiplier(float multiplier)
```

Set the parallax scroll multiplier used in conjunction with `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#COLLAPSE_MODE_PARALLAX()`. A value of `0.0` indicates no movement at all, `1.0f` indicates normal scroll movement.

| Parameters |
|---|---|
| `float multiplier` | the multiplier. |

| See also |
|---|---|
| `https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout.LayoutParams#getParallaxMultiplier()` |   |