# PrimaryLayout

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

*** ** * ** ***


```
public class PrimaryLayout implements LayoutElementBuilders.LayoutElement
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
>
> Use the new class `https://developer.android.com/reference/androidx/wear/protolayout/material/layouts/PrimaryLayout` which provides the same API and functionality.

Tiles layout that represents a suggested layout style for Material Tiles with the primary (compact) chip at the bottom with the given content in the center and the recommended margin and padding applied. There is a fixed slot for an optional primary label above or optional secondary label below the main content area.

It is highly recommended that main content has max lines between 2 and 4 (dependant on labels present), i.e.: \* No labels are present: content with max 4 lines, \* 1 label is present: content with max 3 lines, \* 2 labels are present: content with max 2 lines.

For additional examples and suggested layouts see [Tiles Design System](https://developer.android.com/training/wearables/design/tiles-design-system).

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.:

```
PrimaryLayout pl = new PrimaryLayout...
Box box = new Box.Builder().addContent(pl).build();

PrimaryLayout myPl = (PrimaryLayout) box.getContents().get(0);
```
will fail.

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

```
PrimaryLayout myPl = PrimaryLayout.fromLayoutElement(box.getContents().get(0));
```

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout.Builder implements https://developer.android.com/reference/androidx/wear/tiles/LayoutElementBuilders.LayoutElement.Builder` **This class is deprecated.** Deprecated in Java |

| ### Public methods |
|---|---|
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout` | `[fromLayoutElement](https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout#fromLayoutElement(androidx.wear.tiles.LayoutElementBuilders.LayoutElement))(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/tiles/LayoutElementBuilders.LayoutElement element)` **This method is deprecated.** Deprecated in Java |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/tiles/LayoutElementBuilders.LayoutElement` | `[getContent](https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout#getContent())()` **This method is deprecated.** Deprecated in Java |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/tiles/LayoutElementBuilders.LayoutElement` | `[getPrimaryChipContent](https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout#getPrimaryChipContent())()` **This method is deprecated.** Deprecated in Java |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/tiles/LayoutElementBuilders.LayoutElement` | `[getPrimaryLabelTextContent](https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout#getPrimaryLabelTextContent())()` **This method is deprecated.** Deprecated in Java |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/tiles/LayoutElementBuilders.LayoutElement` | `[getSecondaryLabelTextContent](https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout#getSecondaryLabelTextContent())()` **This method is deprecated.** Deprecated in Java |
| `@https://developer.android.com/reference/androidx/annotation/Dimension(unit = 0) float` | `[getVerticalSpacerHeight](https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout#getVerticalSpacerHeight())()` **This method is deprecated.** Deprecated in Java |

## Public methods

### fromLayoutElement

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.1.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.2.0)

```
public static @Nullable PrimaryLayout [fromLayoutElement](https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout#fromLayoutElement(androidx.wear.tiles.LayoutElementBuilders.LayoutElement))(@NonNull LayoutElementBuilders.LayoutElement element)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

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

### getContent

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.1.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.2.0)

```
public @Nullable LayoutElementBuilders.LayoutElement [getContent](https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout#getContent())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Get the inner content from this layout.

### getPrimaryChipContent

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.1.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.2.0)

```
public @Nullable LayoutElementBuilders.LayoutElement [getPrimaryChipContent](https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout#getPrimaryChipContent())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Get the primary chip content from this layout.

### getPrimaryLabelTextContent

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.1.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.2.0)

```
public @Nullable LayoutElementBuilders.LayoutElement [getPrimaryLabelTextContent](https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout#getPrimaryLabelTextContent())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Get the primary label content from this layout.

### getSecondaryLabelTextContent

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.1.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.2.0)

```
public @Nullable LayoutElementBuilders.LayoutElement [getSecondaryLabelTextContent](https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout#getSecondaryLabelTextContent())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Get the secondary label content from this layout.

### getVerticalSpacerHeight

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.1.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.2.0)

```
public @Dimension(unit = 0) float [getVerticalSpacerHeight](https://developer.android.com/reference/androidx/wear/tiles/material/layouts/PrimaryLayout#getVerticalSpacerHeight())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Get the vertical spacer height from this layout.