File: UiTranslationSpec.java

package info (click to toggle)
android-platform-frameworks-base 1%3A14~beta1-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 326,092 kB
  • sloc: java: 2,032,373; xml: 343,016; cpp: 304,181; python: 3,683; ansic: 2,090; sh: 1,871; makefile: 117; sed: 19
file content (252 lines) | stat: -rw-r--r-- 9,786 bytes parent folder | download | duplicates (2)
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
/*
 * 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.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;
import android.widget.TextView;

import com.android.internal.util.DataClass;

/**
 * Specifications for configuring UI translation.
 *
 * @hide
 */
@DataClass(
        genBuilder = true, genEqualsHashCode = true, genHiddenConstDefs = true, genToString = true)
@DataClass.Suppress("isShouldPadContentForCompat")
@SystemApi
public final class UiTranslationSpec implements Parcelable {

    /**
     * Whether the original content of the view should be made to appear as if it is the same size
     * as the translated content. Defaults to {@code false}.
     * <p>
     * For {@link TextView}, the system does not directly modify the original text, rather
     * changes the displayed content using a {@link android.text.method.TransformationMethod}. This
     * can cause issues in apps that do not account for length-changing TransformationMethods. For
     * example, an app using DynamicLayout may use the calculated line-offsets to operate on the
     * original text, but this can cause crashes when the layout was calculated on translated text
     * with a different length.
     * <p>
     * If this is {@code true}, for a TextView the default implementation appends spaces to the
     * result of {@link TextView#getText()} to make the length the same as the translated text.
     * <p>
     * This only affects apps with target SDK R or lower.
     */
    private boolean mShouldPadContentForCompat = false;

    /**
     * Whether the original content of the view should be made to appear as if it is the same size
     * as the translated content.
     * <p>
     * For {@link TextView}, the system does not directly modify the original text, rather
     * changes the displayed content using a {@link android.text.method.TransformationMethod}. This
     * can cause issues in apps that do not account for length-changing TransformationMethods. For
     * example, an app using DynamicLayout may use the calculated line-offsets to operate on the
     * original text, but this can cause crashes when the layout was calculated on translated text
     * with a different length.
     * <p>
     * If this is {@code true}, for a TextView the default implementation appends spaces to the
     * result of {@link TextView#getText()} to make the length the same as the translated text.
     * <p>
     * This only affects apps with target SDK R or lower.
     */
    public boolean shouldPadContentForCompat() {
        return mShouldPadContentForCompat;
    }



    // Code below generated by codegen v1.0.23.
    //
    // DO NOT MODIFY!
    // CHECKSTYLE:OFF Generated code
    //
    // To regenerate run:
    // $ codegen $ANDROID_BUILD_TOP/frameworks/base/core/java/android/view/translation/UiTranslationSpec.java
    //
    // To exclude the generated code from IntelliJ auto-formatting enable (one-time):
    //   Settings > Editor > Code Style > Formatter Control
    //@formatter:off


    @DataClass.Generated.Member
    /* package-private */ UiTranslationSpec(
            boolean shouldPadContentForCompat) {
        this.mShouldPadContentForCompat = shouldPadContentForCompat;

        // onConstructed(); // You can define this method to get a callback
    }

    @Override
    @DataClass.Generated.Member
    public String toString() {
        // You can override field toString logic by defining methods like:
        // String fieldNameToString() { ... }

        return "UiTranslationSpec { " +
                "shouldPadContentForCompat = " + mShouldPadContentForCompat +
        " }";
    }

    @Override
    @DataClass.Generated.Member
    public boolean equals(@android.annotation.Nullable Object o) {
        // You can override field equality logic by defining either of the methods like:
        // boolean fieldNameEquals(UiTranslationSpec other) { ... }
        // boolean fieldNameEquals(FieldType otherValue) { ... }

        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        @SuppressWarnings("unchecked")
        UiTranslationSpec that = (UiTranslationSpec) o;
        //noinspection PointlessBooleanExpression
        return true
                && mShouldPadContentForCompat == that.mShouldPadContentForCompat;
    }

    @Override
    @DataClass.Generated.Member
    public int hashCode() {
        // You can override field hashCode logic by defining methods like:
        // int fieldNameHashCode() { ... }

        int _hash = 1;
        _hash = 31 * _hash + Boolean.hashCode(mShouldPadContentForCompat);
        return _hash;
    }

    @Override
    @DataClass.Generated.Member
    public void writeToParcel(@NonNull Parcel dest, int flags) {
        // You can override field parcelling by defining methods like:
        // void parcelFieldName(Parcel dest, int flags) { ... }

        byte flg = 0;
        if (mShouldPadContentForCompat) flg |= 0x1;
        dest.writeByte(flg);
    }

    @Override
    @DataClass.Generated.Member
    public int describeContents() { return 0; }

    /** @hide */
    @SuppressWarnings({"unchecked", "RedundantCast"})
    @DataClass.Generated.Member
    /* package-private */ UiTranslationSpec(@NonNull Parcel in) {
        // You can override field unparcelling by defining methods like:
        // static FieldType unparcelFieldName(Parcel in) { ... }

        byte flg = in.readByte();
        boolean shouldPadContentForCompat = (flg & 0x1) != 0;

        this.mShouldPadContentForCompat = shouldPadContentForCompat;

        // onConstructed(); // You can define this method to get a callback
    }

    @DataClass.Generated.Member
    public static final @NonNull Parcelable.Creator<UiTranslationSpec> CREATOR
            = new Parcelable.Creator<UiTranslationSpec>() {
        @Override
        public UiTranslationSpec[] newArray(int size) {
            return new UiTranslationSpec[size];
        }

        @Override
        public UiTranslationSpec createFromParcel(@NonNull Parcel in) {
            return new UiTranslationSpec(in);
        }
    };

    /**
     * A builder for {@link UiTranslationSpec}
     */
    @SuppressWarnings("WeakerAccess")
    @DataClass.Generated.Member
    public static final class Builder {

        private boolean mShouldPadContentForCompat;

        private long mBuilderFieldsSet = 0L;

        public Builder() {
        }

        /**
         * Whether the original content of the view should be made to appear as if it is the same size
         * as the translated content. Defaults to {@code false}.
         * <p>
         * For {@link TextView}, the system does not directly modify the original text, rather
         * changes the displayed content using a {@link android.text.method.TransformationMethod}. This
         * can cause issues in apps that do not account for length-changing TransformationMethods. For
         * example, an app using DynamicLayout may use the calculated line-offsets to operate on the
         * original text, but this can cause crashes when the layout was calculated on translated text
         * with a different length.
         * <p>
         * If this is {@code true}, for a TextView the default implementation appends spaces to the
         * result of {@link TextView#getText()} to make the length the same as the translated text.
         * <p>
         * This only affects apps with target SDK R or lower.
         */
        @DataClass.Generated.Member
        public @NonNull Builder setShouldPadContentForCompat(boolean value) {
            checkNotUsed();
            mBuilderFieldsSet |= 0x1;
            mShouldPadContentForCompat = value;
            return this;
        }

        /** Builds the instance. This builder should not be touched after calling this! */
        public @NonNull UiTranslationSpec build() {
            checkNotUsed();
            mBuilderFieldsSet |= 0x2; // Mark builder used

            if ((mBuilderFieldsSet & 0x1) == 0) {
                mShouldPadContentForCompat = false;
            }
            UiTranslationSpec o = new UiTranslationSpec(
                    mShouldPadContentForCompat);
            return o;
        }

        private void checkNotUsed() {
            if ((mBuilderFieldsSet & 0x2) != 0) {
                throw new IllegalStateException(
                        "This Builder should not be reused. Use a new Builder instance instead");
            }
        }
    }

    @DataClass.Generated(
            time = 1620790033058L,
            codegenVersion = "1.0.23",
            sourceFile = "frameworks/base/core/java/android/view/translation/UiTranslationSpec.java",
            inputSignatures = "private  boolean mShouldPadContentForCompat\npublic  boolean shouldPadContentForCompat()\nclass UiTranslationSpec extends java.lang.Object implements [android.os.Parcelable]\n@com.android.internal.util.DataClass(genBuilder=true, genEqualsHashCode=true, genHiddenConstDefs=true, genToString=true)")
    @Deprecated
    private void __metadata() {}


    //@formatter:on
    // End of generated code

}