# BidiFormatter.Builder

Added in[API level 18](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# Builder

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/text/BidiFormatter.Builder "View this page in Java")  

```
class Builder
```

|---|--------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                           ||
| ↳ | [android.text.BidiFormatter.Builder](https://developer.android.com/reference/kotlin/android/text/BidiFormatter.Builder#) |

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

## Summary

|                                                                                                            Public constructors                                                                                                             ||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [Builder](https://developer.android.com/reference/kotlin/android/text/BidiFormatter.Builder#Builder())`()` Constructor.                                                                                                                 |
| [Builder](https://developer.android.com/reference/kotlin/android/text/BidiFormatter.Builder#Builder(kotlin.Boolean))`(`rtlContext:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Constructor. |
| [Builder](https://developer.android.com/reference/kotlin/android/text/BidiFormatter.Builder#Builder(java.util.Locale))`(`locale:` `[Locale](https://developer.android.com/reference/kotlin/java/util/Locale.html#)!`)` Constructor.     |

|                                                                                                                                                                                                                                                     Public methods                                                                                                                                                                                                                                                     ||
|--------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BidiFormatter](https://developer.android.com/reference/kotlin/android/text/BidiFormatter)!                  | [build](https://developer.android.com/reference/kotlin/android/text/BidiFormatter.Builder#build())`()` <br />                                                                                                                                                                                                                                                                                            |
| [BidiFormatter.Builder](https://developer.android.com/reference/kotlin/android/text/BidiFormatter.Builder#)! | [setTextDirectionHeuristic](https://developer.android.com/reference/kotlin/android/text/BidiFormatter.Builder#setTextDirectionHeuristic(android.text.TextDirectionHeuristic))`(`heuristic:` `[TextDirectionHeuristic](https://developer.android.com/reference/kotlin/android/text/TextDirectionHeuristic)!`)` Specifies the default directionality estimation algorithm to be used by the BidiFormatter. |
| [BidiFormatter.Builder](https://developer.android.com/reference/kotlin/android/text/BidiFormatter.Builder#)! | [stereoReset](https://developer.android.com/reference/kotlin/android/text/BidiFormatter.Builder#stereoReset(kotlin.Boolean))`(`stereoReset:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` 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[API level 18](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
Builder()
```

Constructor.  

### Builder

Added in[API level 18](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
Builder(rtlContext: Boolean)
```

Constructor.

|                                                                 Parameters                                                                  ||
|--------------|-------------------------------------------------------------------------------------------------------------------------------|
| `rtlContext` | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html):Whether the context directionality is RTL. |

### Builder

Added in[API level 18](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
Builder(locale: Locale!)
```

Constructor.

|                                                   Parameters                                                   ||
|----------|------------------------------------------------------------------------------------------------------|
| `locale` | [Locale](https://developer.android.com/reference/kotlin/java/util/Locale.html#)!:The context locale. |

## Public methods

### build

Added in[API level 18](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun build(): BidiFormatter!
```

|                                                                  Return                                                                  ||
|---------------------------------------------------------------------------------------------|---------------------------------------------|
| [BidiFormatter](https://developer.android.com/reference/kotlin/android/text/BidiFormatter)! | A BidiFormatter with the specified options. |

### setTextDirectionHeuristic

Added in[API level 18](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setTextDirectionHeuristic(heuristic: TextDirectionHeuristic!): BidiFormatter.Builder!
```

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

|                                                                          Parameters                                                                           ||
|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| `heuristic` | [TextDirectionHeuristic](https://developer.android.com/reference/kotlin/android/text/TextDirectionHeuristic)!:the`TextDirectionHeuristic`to use. |

|                                                              Return                                                               ||
|--------------------------------------------------------------------------------------------------------------|---------------------|
| [BidiFormatter.Builder](https://developer.android.com/reference/kotlin/android/text/BidiFormatter.Builder#)! | the builder itself. |

### stereoReset

Added in[API level 18](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun stereoReset(stereoReset: Boolean): BidiFormatter.Builder!
```

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.