UiTranslationManager

Kotlin |Java

public final class UiTranslationManager
extends Object

java.lang.Object
↳	android.view.translation.UiTranslationManager

The UiTranslationManager class provides ways for apps to use the ui translation function in framework.

The UI translation provides ways for apps to support inline translation for the views. For example the system supports text translation for TextView. To support UI translation for your views, you should override the following methods to provide the content to be translated and deal with the translated result. Here is an example for TextView-like views:


 public class MyTextView extends View {
     public MyTextView(...) {
         // implements how to show the translated result in your View in
         // ViewTranslationCallback and set it by setViewTranslationCallback()
         setViewTranslationCallback(new MyViewTranslationCallback());
     }

     public void onCreateViewTranslationRequest(int[] supportedFormats,
             Consumer requestsCollector) {
        // collect the information that needs to be translated
        ViewTranslationRequest.Builder requestBuilder =
                     new ViewTranslationRequest.Builder(getAutofillId());
        requestBuilder.setValue(ViewTranslationRequest.ID_TEXT,
                         TranslationRequestValue.forText(etText()));
        requestsCollector.accept(requestBuilder.build());
     }

     public void onProvideContentCaptureStructure(
             ViewStructure structure, int flags) {
         // set ViewTranslationResponse
         super.onViewTranslationResponse(response);
     }
 }

If your view provides its own virtual hierarchy (for example, if it's a browser that draws the HTML using Canvas or native libraries in a different render process), you must override View#onCreateVirtualViewTranslationRequests(long[], int[], Consumer) to provide the content to be translated and implement View#onVirtualViewTranslationResponses(android.util.LongSparseArray) for the translated result. You also need to implement ViewTranslationCallback to handle the translated information show or hide in your View.

Summary

Public methods
`void`	`registerUiTranslationStateCallback(Executor executor, UiTranslationStateCallback callback)` Register for notifications of UI Translation state changes on the foreground Activity.
`void`	`unregisterUiTranslationStateCallback(UiTranslationStateCallback callback)` Unregister `callback`.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

registerUiTranslationStateCallback

Added in API level 31

public void registerUiTranslationStateCallback (Executor executor, 
                UiTranslationStateCallback callback)

Register for notifications of UI Translation state changes on the foreground Activity. This is available to the owning application itself and also the current input method.

The application whose UI is being translated can use this to customize the UI Translation behavior in ways that aren't made easy by methods like View#onCreateViewTranslationRequest(int[], Consumer).

Input methods can use this to offer complementary features to UI Translation; for example, enabling outgoing message translation when the system is translating incoming messages in a communication app.

Starting from Build.VERSION_CODES.TIRAMISU, if Activities are already being translated when a callback is registered, methods on the callback will be invoked for each translated activity, depending on the state of translation:

If translation is not paused, UiTranslationStateCallback#onStarted will be invoked.
If translation is paused, UiTranslationStateCallback#onStarted will first be invoked, followed by UiTranslationStateCallback#onPaused.

Parameters
`executor`	`Executor`: This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.
`callback`	`UiTranslationStateCallback`: the callback to register for receiving the state change notifications This value cannot be `null`.

unregisterUiTranslationStateCallback

Added in API level 31

public void unregisterUiTranslationStateCallback (UiTranslationStateCallback callback)

Unregister callback.

Parameters
`callback`	`UiTranslationStateCallback`: This value cannot be `null`.

See also:

registerUiTranslationStateCallback(Executor, UiTranslationStateCallback)