# BidiFormatter.Builder

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/BidiFormatter.java+class:androidx.core.text.BidiFormatter.Builder) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

*** ** * ** ***


```
public final class BidiFormatter.Builder
```

<br />

*** ** * ** ***

A class for building a BidiFormatter with non-default options.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/core/text/BidiFormatter.Builder#Builder()()` Constructor. |
| `https://developer.android.com/reference/androidx/core/text/BidiFormatter.Builder#Builder(java.util.Locale)(https://developer.android.com/reference/java/util/Locale.html locale)` Constructor. |
| `https://developer.android.com/reference/androidx/core/text/BidiFormatter.Builder#Builder(boolean)(boolean rtlContext)` Constructor. |

| ### Public methods |
|---|---|
| `https://developer.android.com/reference/androidx/core/text/BidiFormatter` | `https://developer.android.com/reference/androidx/core/text/BidiFormatter.Builder#build()()` |
| `https://developer.android.com/reference/androidx/core/text/BidiFormatter.Builder` | `https://developer.android.com/reference/androidx/core/text/BidiFormatter.Builder#setTextDirectionHeuristic(androidx.core.text.TextDirectionHeuristicCompat)(https://developer.android.com/reference/androidx/core/text/TextDirectionHeuristicCompat heuristic)` Specifies the default directionality estimation algorithm to be used by the BidiFormatter. |
| `https://developer.android.com/reference/androidx/core/text/BidiFormatter.Builder` | `https://developer.android.com/reference/androidx/core/text/BidiFormatter.Builder#stereoReset(boolean)(boolean stereoReset)` Specifies whether the BidiFormatter to be built should also "reset" directionality before a string being bidi-wrapped, not just after it. |

## Public constructors

### Builder

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public Builder()
```

Constructor.

### Builder

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public Builder(Locale locale)
```

Constructor.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/util/Locale.html locale` | The context locale. |

### Builder

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public Builder(boolean rtlContext)
```

Constructor.

| Parameters |
|---|---|
| `boolean rtlContext` | Whether the context directionality is RTL. |

## Public methods

### build

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public BidiFormatter build()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/core/text/BidiFormatter` | A BidiFormatter with the specified options. |

### setTextDirectionHeuristic

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public BidiFormatter.Builder setTextDirectionHeuristic(TextDirectionHeuristicCompat heuristic)
```

Specifies the default directionality estimation algorithm to be used by the BidiFormatter. By default, uses the first-strong heuristic.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/core/text/TextDirectionHeuristicCompat heuristic` | the `TextDirectionHeuristic` to use. |

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/core/text/BidiFormatter.Builder` | the builder itself. |

### stereoReset

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public BidiFormatter.Builder stereoReset(boolean stereoReset)
```

Specifies whether the BidiFormatter to be built should also "reset" directionality before a string being bidi-wrapped, not just after it. The default is true.