# BidiFormatter.Builder

# 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)

*** ** * ** ***

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

<br />

```
class BidiFormatter.Builder
```

<br />

*** ** * ** ***

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

## Summary

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

|                                                ### Public functions                                                 |
|---------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BidiFormatter](https://developer.android.com/reference/kotlin/androidx/core/text/BidiFormatter)`!`                 | [build](https://developer.android.com/reference/kotlin/androidx/core/text/BidiFormatter.Builder#build())`()`                                                                                                                                                                                                                                                                                                                               |
| [BidiFormatter.Builder](https://developer.android.com/reference/kotlin/androidx/core/text/BidiFormatter.Builder)`!` | [setTextDirectionHeuristic](https://developer.android.com/reference/kotlin/androidx/core/text/BidiFormatter.Builder#setTextDirectionHeuristic(androidx.core.text.TextDirectionHeuristicCompat))`(heuristic: `[TextDirectionHeuristicCompat](https://developer.android.com/reference/kotlin/androidx/core/text/TextDirectionHeuristicCompat)`!)` Specifies the default directionality estimation algorithm to be used by the BidiFormatter. |
| [BidiFormatter.Builder](https://developer.android.com/reference/kotlin/androidx/core/text/BidiFormatter.Builder)`!` | [stereoReset](https://developer.android.com/reference/kotlin/androidx/core/text/BidiFormatter.Builder#stereoReset(boolean))`(stereoReset: `[Boolean](https://kotlinlang.org/api/core/kotlin-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[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)  

```
Builder()
```

Constructor.  

### Builder

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

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

Constructor.  

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

### Builder

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

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

Constructor.  

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

## Public functions

### build

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

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

|                                               Returns                                               |
|-----------------------------------------------------------------------------------------------------|---------------------------------------------|
| [BidiFormatter](https://developer.android.com/reference/kotlin/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)  

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

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

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

|                                                       Returns                                                       |
|---------------------------------------------------------------------------------------------------------------------|---------------------|
| [BidiFormatter.Builder](https://developer.android.com/reference/kotlin/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)  

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