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.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# BidiFormatter.Builder\n\nadded in [version 22.1.0](/topic/libraries/support-library/revisions) \nbelongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1 \nSummary: [Ctors](#pubctors) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \\| [\\[Expand All\\]](#) \n\nBidiFormatter.Builder\n=====================\n\n| This package is part of the Android [support library](/topic/libraries/support-library) which is no longer maintained. The support library has been superseded by [AndroidX](/jetpack/androidx) which is part of [Jetpack](/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider [migrating](/jetpack/androidx/migrate) existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library [class\n| mappings](/jetpack/androidx/migrate/class-mappings).\n\n\n`\npublic\nstatic\nfinal\n\nclass\nBidiFormatter.Builder\n`\n\n\n`\n\nextends Object\n\n\n`\n\n`\n\n\n`\n\n|---|-----------------------------------------------|\n| java.lang.Object ||\n| ↳ | android.support.v4.text.BidiFormatter.Builder |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nA class for building a BidiFormatter with non-default options.\n\nSummary\n-------\n\n| ### Public constructors ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ` `[BidiFormatter.Builder](/reference/android/support/v4/text/BidiFormatter.Builder#BidiFormatter.Builder())`() ` Constructor. |\n| ` `[BidiFormatter.Builder](/reference/android/support/v4/text/BidiFormatter.Builder#BidiFormatter.Builder(boolean))`(boolean rtlContext) ` Constructor. |\n| ` `[BidiFormatter.Builder](/reference/android/support/v4/text/BidiFormatter.Builder#BidiFormatter.Builder(java.util.Locale))`(Locale locale) ` Constructor. |\n\n| ### Public methods ||\n|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` `[BidiFormatter](/reference/android/support/v4/text/BidiFormatter) | ` `[build](/reference/android/support/v4/text/BidiFormatter.Builder#build())`() ` |\n| ` `[BidiFormatter.Builder](/reference/android/support/v4/text/BidiFormatter.Builder) | ` `[setTextDirectionHeuristic](/reference/android/support/v4/text/BidiFormatter.Builder#setTextDirectionHeuristic(android.support.v4.text.TextDirectionHeuristicCompat))`(`[TextDirectionHeuristicCompat](/reference/android/support/v4/text/TextDirectionHeuristicCompat)` heuristic) ` Specifies the default directionality estimation algorithm to be used by the BidiFormatter. |\n| ` `[BidiFormatter.Builder](/reference/android/support/v4/text/BidiFormatter.Builder) | ` `[stereoReset](/reference/android/support/v4/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. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` java.lang.Object ` |-------------------|-------------------------------| | ` Object` | ` clone() ` | | ` boolean` | ` equals(Object arg0) ` | | ` void` | ` finalize() ` | | ` final Class\u003c?\u003e` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` String` | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | ||\n\nPublic constructors\n-------------------\n\n### BidiFormatter.Builder\n\nadded in [version 22.1.0](/topic/libraries/support-library/revisions) \n\n```\nBidiFormatter.Builder ()\n```\n\nConstructor.\n\n\u003cbr /\u003e\n\n### BidiFormatter.Builder\n\nadded in [version 22.1.0](/topic/libraries/support-library/revisions) \n\n```\nBidiFormatter.Builder (boolean rtlContext)\n```\n\nConstructor.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|--------------|--------------------------------------------------------------|\n| `rtlContext` | `boolean`: Whether the context directionality is RTL. \u003cbr /\u003e |\n\n### BidiFormatter.Builder\n\nadded in [version 22.1.0](/topic/libraries/support-library/revisions) \n\n```\nBidiFormatter.Builder (Locale locale)\n```\n\nConstructor.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|----------|--------------------------------------|\n| `locale` | `Locale`: The context locale. \u003cbr /\u003e |\n\nPublic methods\n--------------\n\n### build\n\nadded in [version 22.1.0](/topic/libraries/support-library/revisions) \n\n```\nBidiFormatter build ()\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ||\n|-------------------------------------------------------------------|----------------------------------------------------|\n| [BidiFormatter](/reference/android/support/v4/text/BidiFormatter) | A BidiFormatter with the specified options. \u003cbr /\u003e |\n\n### setTextDirectionHeuristic\n\nadded in [version 22.1.0](/topic/libraries/support-library/revisions) \n\n```\nBidiFormatter.Builder setTextDirectionHeuristic (TextDirectionHeuristicCompat heuristic)\n```\n\nSpecifies the default directionality estimation algorithm to be used by the BidiFormatter.\nBy default, uses the first-strong heuristic.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------|\n| `heuristic` | `TextDirectionHeuristicCompat`: the `TextDirectionHeuristic` to use. \u003cbr /\u003e |\n\n| Returns ||\n|-----------------------------------------------------------------------------------|----------------------------|\n| [BidiFormatter.Builder](/reference/android/support/v4/text/BidiFormatter.Builder) | the builder itself. \u003cbr /\u003e |\n\n### stereoReset\n\nadded in [version 22.1.0](/topic/libraries/support-library/revisions) \n\n```\nBidiFormatter.Builder stereoReset (boolean stereoReset)\n```\n\nSpecifies whether the BidiFormatter to be built should also \"reset\" directionality before\na string being bidi-wrapped, not just after it. The default is true.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------------|------------------|\n| `stereoReset` | `boolean` \u003cbr /\u003e |\n\n| Returns ||\n|-----------------------------------------------------------------------------------|--------|\n| [BidiFormatter.Builder](/reference/android/support/v4/text/BidiFormatter.Builder) | \u003cbr /\u003e |\n\n-\n\n Interfaces\n ----------\n\n - [TextDirectionHeuristicCompat](/reference/android/support/v4/text/TextDirectionHeuristicCompat)\n-\n\n Classes\n -------\n\n - [BidiFormatter](/reference/android/support/v4/text/BidiFormatter)\n - [BidiFormatter.Builder](/reference/android/support/v4/text/BidiFormatter.Builder)\n - [ICUCompat](/reference/android/support/v4/text/ICUCompat)\n - [TextDirectionHeuristicsCompat](/reference/android/support/v4/text/TextDirectionHeuristicsCompat)\n - [TextUtilsCompat](/reference/android/support/v4/text/TextUtilsCompat)"]]
From
class