Language

UiTranslationManager Class

Definition

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

[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
UiTranslationManager
Attributes

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

Name Description
Class

Returns the runtime class of this Object.

(Inherited from Object)
Handle

The handle to the underlying Android instance.

(Inherited from Object)
JniIdentityHashCode

Gets the identity hash code assigned to this Java peer by the interop runtime.

(Inherited from Object)
JniManagedPeerState (Inherited from JavaObject)
JniPeerMembers
PeerReference

Gets the JNI object reference for this Java peer.

(Inherited from Object)
ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

(Inherited from Object)
ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

(Inherited from Object)

Methods

Name Description
Clone()

Creates and returns a copy of this object.

(Inherited from Object)
Construct(JniObjectReference, JniObjectReferenceOptions) (Inherited from JavaObject)
Dispose()

Releases the resources held by this Java peer.

(Inherited from Object)
Dispose(Boolean)

Releases the resources held by this Java peer.

(Inherited from Object)
DisposeUnlessReferenced() (Inherited from JavaObject)
Equals(Object) (Inherited from JavaObject)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
JavaFinalize()
Obsolete.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
RegisterUiTranslationStateCallback(IExecutor, IUiTranslationStateCallback)

Register for notifications of UI Translation state changes on the foreground Activity.

SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions) (Inherited from JavaObject)
ToArray<T>()

Creates a managed array from this Java array wrapper.

(Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime()

Unregisters this Java peer from the interop runtime.

(Inherited from Object)
UnregisterUiTranslationStateCallback(IUiTranslationStateCallback)

Unregister callback.

Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)

Explicit Interface Implementations

Name Description
IJavaPeerable.Disposed() (Inherited from JavaObject)
IJavaPeerable.Finalized() (Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock (Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32) (Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) (Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference) (Inherited from JavaObject)

Extension Methods

Name Description
GetJniTypeName(IJavaPeerable)

Gets the JNI name of the type of the instance self.

JavaAs<TResult>(IJavaPeerable)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
TryJavaCast<TResult>(IJavaPeerable, TResult)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

Applies to