1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/*
* Copyright (C) 2021 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.view.translation;
import android.annotation.NonNull;
import android.annotation.UiThread;
import android.view.View;
import android.view.contentcapture.ContentCaptureSession;
/**
* <p> Callback for handling the translated information show or hide in the {@link View}.
*
* <p> When the platform intelligence starts translation of an app's ui, the system will call
* {@link View#dispatchCreateViewTranslationRequest} to collect the {@link ViewTranslationRequest}s
* for translation purpose by traversing the hierarchy then send to translation service. After
* receiving the {@link ViewTranslationResponse}, the system will call
* {@link ViewTranslationCallback#onShowTranslation(View)} to show the translated information for
* the {@link View}.
*/
@UiThread
public interface ViewTranslationCallback {
/**
* Called when the translated text is ready to show or if the user has requested to reshow the
* translated content after hiding it.
* <p>
* The translated content can be obtained from {@link View#getViewTranslationResponse}. This
* method will not be called before {@link View#onViewTranslationResponse} or
* {@link View#onVirtualViewTranslationResponses}.
*
* <p> NOTE: It is possible the user changes text that causes a new
* {@link ViewTranslationResponse} returns to show the new translation. If you cache the
* {@link ViewTranslationResponse} here, you should remember to keep the cached value up
* to date.
*
* <p> NOTE: For TextView implementation, {@link ContentCaptureSession#notifyViewTextChanged}
* shouldn't be called with the translated text, simply calling setText() here will trigger the
* method. You should either override {@code View#onProvideContentCaptureStructure()} to report
* the original text instead of the translated text or use a different approach to display the
* translated text.
*
* <p> NOTE: In Android version {@link android.os.Build.VERSION_CODES#TIRAMISU} and later,
* the implementation must be able to handle a selectable {@link android.widget.TextView}
* (i.e., {@link android.widget.TextView#isTextSelectable()} returns {@code true}. The default
* callback implementation for TextView uses a {@link android.text.method.TransformationMethod}
* to show the translated text, which will cause a crash when the translated text is selected.
* Therefore, the default callback temporarily makes the TextView non-selectable while the
* translation text is shown. This is one approach for handling selectable TextViews a
* TransformationMethod is used.
*
* See {@link View#onViewTranslationResponse} for how to get the translated information.
*
* @return {@code true} if the View handles showing the translation.
*/
boolean onShowTranslation(@NonNull View view);
/**
* Called when user wants to view the original content instead of the translated content. This
* method will not be called before {@link View#onViewTranslationResponse} or
* {@link View#onVirtualViewTranslationResponses}.
*
* @return {@code true} if the View handles hiding the translation.
*/
boolean onHideTranslation(@NonNull View view);
/**
* Called when the translation state is no longer needed. It should restore the original content
* and clear all saved states.
*
* @return {@code true} if the View handles clearing the translation.
*/
boolean onClearTranslation(@NonNull View view);
/**
* Enables padding on the view's original content.
* <p>
* This is useful when we do not modify the content directly, rather use a mechanism like
* {@link android.text.method.TransformationMethod}. If the app misbehaves when the displayed
* translation and the underlying content have different sizes, the platform intelligence can
* request that the original content be padded to make the sizes match.
*
* @hide
*/
default void enableContentPadding() {}
/**
* Sets the duration for animations while transitioning the view between the original and
* translated contents.
*
* @hide
*/
default void setAnimationDurationMillis(int durationMillis) {}
}
|
