# MultiSlotLayout

Artifact: [androidx.wear.protolayout:protolayout-material](https://developer.android.com/jetpack/androidx/releases/wear-protolayout) [View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/material/layouts/MultiSlotLayout.java+class:androidx.wear.protolayout.material.layouts.MultiSlotLayout) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

*** ** * ** ***


```
public class MultiSlotLayout implements LayoutElementBuilders.LayoutElement
```

<br />

*** ** * ** ***

Opinionated ProtoLayout layout, row like style with horizontally aligned and spaced slots (for icons or other small content). Should be used as a content passed in to the `https://developer.android.com/reference/androidx/wear/protolayout/material/layouts/PrimaryLayout`. Visuals and design samples can be found [here](https://developer.android.com/design/ui/wear/guides/surfaces/tiles-layouts#info-centric-with-progress-indicator).

Recommended number of added slots is 1 to 3. Their width will be the width of an element passed in, with the `https://developer.android.com/reference/androidx/wear/protolayout/material/layouts/LayoutDefaults#MULTI_SLOT_LAYOUT_HORIZONTAL_SPACER_WIDTH()` space between.

When accessing the contents of a container for testing, note that this element can't be simply casted back to the original type, i.e.:

```
MultiSlotLayout msl = new MultiSlotLayout...
Box box = new Box.Builder().addContent(msl).build();

MultiSlotLayout myMsl = (MultiSlotLayout) box.getContents().get(0);
```
will fail.

To be able to get `https://developer.android.com/reference/androidx/wear/protolayout/material/layouts/MultiSlotLayout` object from any layout element, `https://developer.android.com/reference/androidx/wear/protolayout/material/layouts/MultiSlotLayout#fromLayoutElement(androidx.wear.protolayout.LayoutElementBuilders.LayoutElement)` method should be used, i.e.:

```
MultiSlotLayout myMsl = MultiSlotLayout.fromLayoutElement(box.getContents().get(0));
```

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/wear/protolayout/material/layouts/MultiSlotLayout.Builder` Builder class for `https://developer.android.com/reference/androidx/wear/protolayout/material/layouts/MultiSlotLayout`. |

| ### Public methods |
|---|---|
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/protolayout/material/layouts/MultiSlotLayout` | `https://developer.android.com/reference/androidx/wear/protolayout/material/layouts/MultiSlotLayout#fromLayoutElement(androidx.wear.protolayout.LayoutElementBuilders.LayoutElement)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.LayoutElement element)` Returns MultiSlotLayout object from the given LayoutElement (e.g. one retrieved from a container's content with `container.getContents().get(index)`) if that element can be converted to MultiSlotLayout. |
| `@https://developer.android.com/reference/androidx/annotation/Dimension(unit = 0) float` | `https://developer.android.com/reference/androidx/wear/protolayout/material/layouts/MultiSlotLayout#getHorizontalSpacerWidth()()` Gets the width of horizontal spacer that is between slots. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.LayoutElement>` | `https://developer.android.com/reference/androidx/wear/protolayout/material/layouts/MultiSlotLayout#getSlotContents()()` Gets the content from this layout, containing all slots that were added. |

## Public methods

### fromLayoutElement

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
public static @Nullable MultiSlotLayout fromLayoutElement(@NonNull LayoutElementBuilders.LayoutElement element)
```

Returns MultiSlotLayout object from the given LayoutElement (e.g. one retrieved from a container's content with `container.getContents().get(index)`) if that element can be converted to MultiSlotLayout. Otherwise, it will return null.

### getHorizontalSpacerWidth

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
public @Dimension(unit = 0) float getHorizontalSpacerWidth()
```

Gets the width of horizontal spacer that is between slots.

### getSlotContents

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
public @NonNull List<LayoutElementBuilders.LayoutElement> getSlotContents()
```

Gets the content from this layout, containing all slots that were added.