Use a shared password text view for PIN lock
This new library will be shared with external.
Bug: 270108982
Test: Manual test by building and flashing on local
Test: Tested both hinting and non-hinting pin view. Tested append, delete, full delete, reset, lockout and talkback
Change-Id: I0ddc7c46848c5430d08d2b39ffa0a524e695ebc0
diff --git a/packages/SystemUI/shared/keyguard/Android.bp b/packages/SystemUI/shared/keyguard/Android.bp
new file mode 100644
index 0000000..2181439
--- /dev/null
+++ b/packages/SystemUI/shared/keyguard/Android.bp
@@ -0,0 +1,16 @@
+package {
+ // See: http://go/android-license-faq
+ // A large-scale-change added 'default_applicable_licenses' to import
+ // all of the 'license_kinds' from "frameworks_base_packages_SystemUI_license"
+ // to get the below license kinds:
+ // SPDX-license-identifier-Apache-2.0
+ default_applicable_licenses: ["frameworks_base_packages_SystemUI_license"],
+}
+
+android_library {
+ name: "SystemUISharedLib-Keyguard",
+ srcs: [
+ "src/**/*.java",
+ ],
+ min_sdk_version: "current",
+}
diff --git a/packages/SystemUI/shared/keyguard/AndroidManifest.xml b/packages/SystemUI/shared/keyguard/AndroidManifest.xml
new file mode 100644
index 0000000..49bee08
--- /dev/null
+++ b/packages/SystemUI/shared/keyguard/AndroidManifest.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+ ~ Copyright (C) 2023 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.
+ -->
+
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+ package="com.android.systemui.shared.keyguard">
+</manifest>
\ No newline at end of file
diff --git a/packages/SystemUI/shared/keyguard/src/com/android/keyguard/BasePasswordTextView.java b/packages/SystemUI/shared/keyguard/src/com/android/keyguard/BasePasswordTextView.java
new file mode 100644
index 0000000..fe12134
--- /dev/null
+++ b/packages/SystemUI/shared/keyguard/src/com/android/keyguard/BasePasswordTextView.java
@@ -0,0 +1,239 @@
+/*
+ * Copyright (C) 2023 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 com.android.keyguard;
+
+import android.annotation.CallSuper;
+import android.content.Context;
+import android.text.InputType;
+import android.text.TextUtils;
+import android.util.AttributeSet;
+import android.view.accessibility.AccessibilityEvent;
+import android.view.accessibility.AccessibilityManager;
+import android.view.accessibility.AccessibilityNodeInfo;
+import android.widget.EditText;
+import android.widget.FrameLayout;
+
+/**
+ * A View similar to a textView which contains password text and can animate when the text is
+ * changed
+ */
+public abstract class BasePasswordTextView extends FrameLayout {
+ private String mText = "";
+ private UserActivityListener mUserActivityListener;
+ protected boolean mIsPinHinting;
+ protected PinShapeInput mPinShapeInput;
+ protected boolean mShowPassword = true;
+ protected boolean mUsePinShapes = false;
+ protected static final char DOT = '\u2022';
+
+ /** Listens to user activities like appending, deleting and resetting PIN text */
+ public interface UserActivityListener {
+
+ /** Listens to user activities. */
+ void onUserActivity();
+ }
+
+ public BasePasswordTextView(Context context) {
+ this(context, null);
+ }
+
+ public BasePasswordTextView(Context context, AttributeSet attrs) {
+ this(context, attrs, 0);
+ }
+
+ public BasePasswordTextView(Context context, AttributeSet attrs, int defStyleAttr) {
+ this(context, attrs, defStyleAttr, 0);
+ }
+
+ public BasePasswordTextView(
+ Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) {
+ super(context, attrs, defStyleAttr, defStyleRes);
+ }
+
+ protected abstract PinShapeInput inflatePinShapeInput(boolean isPinHinting);
+
+ protected abstract boolean shouldSendAccessibilityEvent();
+
+ protected void onAppend(char c, int newLength) {}
+
+ protected void onDelete(int index) {}
+
+ protected void onReset(boolean animated) {}
+
+ @CallSuper
+ protected void onUserActivity() {
+ if (mUserActivityListener != null) {
+ mUserActivityListener.onUserActivity();
+ }
+ }
+
+ @Override
+ public boolean hasOverlappingRendering() {
+ return false;
+ }
+
+ /** Appends a PIN text */
+ public void append(char c) {
+ CharSequence textbefore = getTransformedText();
+
+ mText = mText + c;
+ int newLength = mText.length();
+ onAppend(c, newLength);
+
+ if (mPinShapeInput != null) {
+ mPinShapeInput.append();
+ }
+
+ onUserActivity();
+
+ sendAccessibilityEventTypeViewTextChanged(textbefore, textbefore.length(), 0, 1);
+ }
+
+ /** Sets a listener who is notified on user activity */
+ public void setUserActivityListener(UserActivityListener userActivityListener) {
+ mUserActivityListener = userActivityListener;
+ }
+
+ /** Deletes the last PIN text */
+ public void deleteLastChar() {
+ int length = mText.length();
+ if (length > 0) {
+ CharSequence textbefore = getTransformedText();
+
+ mText = mText.substring(0, length - 1);
+ onDelete(length - 1);
+
+ if (mPinShapeInput != null) {
+ mPinShapeInput.delete();
+ }
+
+ sendAccessibilityEventTypeViewTextChanged(textbefore, textbefore.length() - 1, 1, 0);
+ }
+ onUserActivity();
+ }
+
+ /** Gets entered PIN text */
+ public String getText() {
+ return mText;
+ }
+
+ /** Gets a transformed text for accessibility event. Called before text changed. */
+ protected CharSequence getTransformedText() {
+ return String.valueOf(DOT).repeat(mText.length());
+ }
+
+ /** Gets a transformed text for accessibility event. Called after text changed. */
+ protected CharSequence getTransformedText(int fromIndex, int removedCount, int addedCount) {
+ return getTransformedText();
+ }
+
+ /** Reset PIN text without error */
+ public void reset(boolean animated, boolean announce) {
+ reset(false /* error */, animated, announce);
+ }
+
+ /** Reset PIN text */
+ public void reset(boolean error, boolean animated, boolean announce) {
+ CharSequence textbefore = getTransformedText();
+
+ mText = "";
+
+ onReset(animated);
+ if (animated) {
+ onUserActivity();
+ }
+
+ if (mPinShapeInput != null) {
+ if (error) {
+ mPinShapeInput.resetWithError();
+ } else {
+ mPinShapeInput.reset();
+ }
+ }
+
+ if (announce) {
+ sendAccessibilityEventTypeViewTextChanged(textbefore, 0, textbefore.length(), 0);
+ }
+ }
+
+ void sendAccessibilityEventTypeViewTextChanged(
+ CharSequence beforeText, int fromIndex, int removedCount, int addedCount) {
+ if (AccessibilityManager.getInstance(mContext).isEnabled()
+ && shouldSendAccessibilityEvent()) {
+ AccessibilityEvent event =
+ AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_TEXT_CHANGED);
+ event.setFromIndex(fromIndex);
+ event.setRemovedCount(removedCount);
+ event.setAddedCount(addedCount);
+ event.setBeforeText(beforeText);
+ CharSequence transformedText = getTransformedText(fromIndex, removedCount, addedCount);
+ if (!TextUtils.isEmpty(transformedText)) {
+ event.getText().add(transformedText);
+ }
+ event.setPassword(true);
+ sendAccessibilityEventUnchecked(event);
+ }
+ }
+
+ /** Sets whether to use pin shapes. */
+ public void setUsePinShapes(boolean usePinShapes) {
+ mUsePinShapes = usePinShapes;
+ }
+
+ /** Determines whether AutoConfirmation feature is on. */
+ public void setIsPinHinting(boolean isPinHinting) {
+ // Do not reinflate the view if we are using the same one.
+ if (mPinShapeInput != null && mIsPinHinting == isPinHinting) {
+ return;
+ }
+ mIsPinHinting = isPinHinting;
+
+ if (mPinShapeInput != null) {
+ removeView(mPinShapeInput.getView());
+ mPinShapeInput = null;
+ }
+
+ mPinShapeInput = inflatePinShapeInput(isPinHinting);
+ addView(mPinShapeInput.getView());
+ }
+
+ /** Controls whether the last entered digit is briefly shown after being entered */
+ public void setShowPassword(boolean enabled) {
+ mShowPassword = enabled;
+ }
+
+ @Override
+ public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
+ super.onInitializeAccessibilityEvent(event);
+
+ event.setClassName(EditText.class.getName());
+ event.setPassword(true);
+ }
+
+ @Override
+ public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
+ super.onInitializeAccessibilityNodeInfo(info);
+
+ info.setClassName(EditText.class.getName());
+ info.setPassword(true);
+ info.setText(getTransformedText());
+
+ info.setEditable(true);
+
+ info.setInputType(InputType.TYPE_NUMBER_VARIATION_PASSWORD);
+ }
+}
diff --git a/packages/SystemUI/shared/keyguard/src/com/android/keyguard/PinShapeInput.java b/packages/SystemUI/shared/keyguard/src/com/android/keyguard/PinShapeInput.java
new file mode 100644
index 0000000..d2b4066
--- /dev/null
+++ b/packages/SystemUI/shared/keyguard/src/com/android/keyguard/PinShapeInput.java
@@ -0,0 +1,58 @@
+/*
+ * Copyright (C) 2023 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 com.android.keyguard;
+
+import android.view.View;
+
+/**
+ * A common interface for classes that provide functionality for the PIN type view
+ */
+public interface PinShapeInput {
+
+ /**
+ * This is the method that is triggered when user types in a character
+ */
+ void append();
+
+ /**
+ * This is the method that is triggered when user deletes a character
+ */
+ void delete();
+
+ /**
+ * This is the method that is triggered for setting the color of the view
+ */
+ void setDrawColor(int color);
+
+ /**
+ * This is the method that is triggered for resetting the view
+ */
+ void reset();
+
+ /**
+ * This is the method that is triggered for resetting the view with error If it doesn't have to
+ * show something regarding error, just reset
+ */
+ default void resetWithError() {
+ reset();
+ }
+
+ /**
+ * This is the method that is triggered for getting the view
+ */
+ View getView();
+}