UiTranslationManager Class

Definition

[Android.Runtime.Register("android/view/translation/UiTranslationManager", ApiSince=31, DoNotGenerateAcw=true)]
public sealed class UiTranslationManager : Java.Lang.Object

[<Android.Runtime.Register("android/view/translation/UiTranslationManager", ApiSince=31, DoNotGenerateAcw=true)>]
type UiTranslationManager = class
    inherit Object

Inheritance

Object

Object

UiTranslationManager

Attributes

RegisterAttribute

Remarks

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:

<code>
            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<ViewTranslationRequest> 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);
                }
            }
</code>

If your view provides its own virtual hierarchy (for example, if it's a browser that draws the HTML using android.graphics.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 android.view.translation.ViewTranslationCallback to handle the translated information show or hide in your View.

Java documentation for android.view.translation.UiTranslationManager.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to