# TitleChip

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/TitleChip.java+class:androidx.wear.protolayout.material.TitleChip) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

*** ** * ** ***


```
public class TitleChip implements LayoutElementBuilders.LayoutElement
```

<br />

*** ** * ** ***

ProtoLayout component `https://developer.android.com/reference/androidx/wear/protolayout/material/TitleChip` that represents clickable object with the text.

The Title Chip is Stadium shaped object with a larger height then standard Chip and it will take one line of text of `https://developer.android.com/reference/androidx/wear/protolayout/material/Typography#TYPOGRAPHY_TITLE2()` style.

The recommended set of `https://developer.android.com/reference/androidx/wear/protolayout/material/ChipColors` styles can be obtained from `https://developer.android.com/reference/androidx/wear/protolayout/material/ChipDefaults`, e.g. `https://developer.android.com/reference/androidx/wear/protolayout/material/ChipDefaults#TITLE_PRIMARY_COLORS()` to get a color scheme for a primary `https://developer.android.com/reference/androidx/wear/protolayout/material/TitleChip`.

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

```
TitleChip chip = new TitleChip...
Box box = new Box.Builder().addContent(chip).build();

TitleChip myChip = (TitleChip) box.getContents().get(0);
```
will fail.

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

```
TitleChip myChip = TitleChip.fromLayoutElement(box.getContents().get(0));
```

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/wear/protolayout/material/layouts/PrimaryLayout.Builder#setContent(androidx.wear.protolayout.LayoutElementBuilders.LayoutElement)` | if this TitleChip is used inside of `https://developer.android.com/reference/androidx/wear/protolayout/material/layouts/PrimaryLayout`. |

## Summary

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

| ### Public methods |
|---|---|
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/protolayout/material/TitleChip` | `https://developer.android.com/reference/androidx/wear/protolayout/material/TitleChip#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 TitleChip 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 TitleChip. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/material/ChipColors` | `https://developer.android.com/reference/androidx/wear/protolayout/material/TitleChip#getChipColors()()` Returns chip color of this Chip. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/ModifiersBuilders.Clickable` | `https://developer.android.com/reference/androidx/wear/protolayout/material/TitleChip#getClickable()()` Returns click event action associated with this Chip. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/protolayout/TypeBuilders.StringProp` | `https://developer.android.com/reference/androidx/wear/protolayout/material/TitleChip#getContentDescription()()` Returns content description of this TitleChip. |
| `int` | `https://developer.android.com/reference/androidx/wear/protolayout/material/TitleChip#getHorizontalAlignment()()` Returns the horizontal alignment of the content in this Chip. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/protolayout/material/TitleChip#getIconContent()()` Returns icon id from this TitleChip if it has been added. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/protolayout/material/TitleChip#getText()()` Returns text content of this Chip. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/DimensionBuilders.ContainerDimension` | `https://developer.android.com/reference/androidx/wear/protolayout/material/TitleChip#getWidth()()` Returns width of this Chip. |

## Public methods

### fromLayoutElement

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

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

Returns TitleChip 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 TitleChip. Otherwise, it will return null.

### getChipColors

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

```
public @NonNull ChipColors getChipColors()
```

Returns chip color of this Chip.

### getClickable

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

```
public @NonNull ModifiersBuilders.Clickable getClickable()
```

Returns click event action associated with this Chip.

### getContentDescription

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

```
public @Nullable TypeBuilders.StringProp getContentDescription()
```

Returns content description of this TitleChip.

### getHorizontalAlignment

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

```
public int getHorizontalAlignment()
```

Returns the horizontal alignment of the content in this Chip.

### getIconContent

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

```
public @Nullable String getIconContent()
```

Returns icon id from this TitleChip if it has been added. Otherwise, it returns null.

### getText

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

```
public @NonNull String getText()
```

Returns text content of this Chip.

### getWidth

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

```
public @NonNull DimensionBuilders.ContainerDimension getWidth()
```

Returns width of this Chip.