Merge pull request #188 from Merkost/talkback_improvements

Talkback improvements

Author: tibbi

app/src/main/kotlin/com/simplemobiletools/keyboard/helpers/AccessHelper.kt

@@ -0,0 +1,69 @@
+package com.simplemobiletools.keyboard.helpers
+
+import android.graphics.Rect
+import android.os.Bundle
+import androidx.core.view.accessibility.AccessibilityNodeInfoCompat
+import androidx.customview.widget.ExploreByTouchHelper
+import com.simplemobiletools.keyboard.views.MyKeyboardView
+
+class AccessHelper(
+    private val keyboardView: MyKeyboardView,
+    private val keys: List<MyKeyboard.Key>
+) : ExploreByTouchHelper(keyboardView) {
+
+    /**
+     * We need to populate the list with the IDs of all of the visible virtual views (the intervals in the chart).
+     * In our case, all keys are always visible, so we’ll return a list of all IDs.
+     */
+    override fun getVisibleVirtualViews(virtualViewIds: MutableList<Int>) {
+        val keysSize = keys.size
+        for (i in 0 until keysSize) {
+            virtualViewIds.add(i)
+        }
+    }
+
+    /**
+     * For this function, we need to return the ID of the virtual view that’s under the x, y position,
+     * or ExploreByTouchHelper.HOST_ID if there’s no item at those coordinates.
+     */
+    override fun getVirtualViewAt(x: Float, y: Float): Int {
+        val rects = keys.map {
+            Rect(it.x, it.y, it.x + it.width, it.y + it.height)
+        }
+
+        return rects.firstOrNull { it.contains(x.toInt(), y.toInt()) }?.let { exactRect ->
+            rects.indexOf(exactRect)
+        } ?: HOST_ID
+    }
+
+    /**
+     * This is where we provide all the metadata for our virtual view.
+     * We need to set the content description (or text, if it’s presented visually) and set the bounds in parent.
+     */
+    override fun onPopulateNodeForVirtualView(virtualViewId: Int, node: AccessibilityNodeInfoCompat) {
+        node.className = keyboardView::class.simpleName
+        val key = keys.getOrNull(virtualViewId)
+        node.contentDescription = key?.getContentDescription(keyboardView.context) ?: ""
+        val bounds = updateBoundsForInterval(virtualViewId)
+        node.setBoundsInParent(bounds)
+    }
+
+    /**
+     * We need to set the content description (or text, if it’s presented visually) and set the bounds in parent.
+     * The bounds in the parent should match the logic in the onDraw() function.
+     */
+    private fun updateBoundsForInterval(index: Int): Rect {
+        val keys = keys
+        val key = keys.getOrNull(index) ?: return Rect()
+        return Rect().apply {
+            left = key.x
+            top = key.y
+            right = key.x + key.width
+            bottom = key.y + key.height
+        }
+    }
+
+    override fun onPerformActionForVirtualView(virtualViewId: Int, action: Int, arguments: Bundle?): Boolean {
+        return false
+    }
+}

app/src/main/kotlin/com/simplemobiletools/keyboard/helpers/MyKeyboard.kt

@@ -43,7 +43,7 @@ class MyKeyboard {
     var mMinWidth = 0
 
     /** List of keys in this keyboard  */
-    var mKeys: MutableList<Key?>? = null
+    var mKeys: MutableList<Key>? = null
 
     /** Width of the screen available to fit the keyboard  */
     private var mDisplayWidth = 0
@@ -225,6 +225,21 @@ class MyKeyboard {
             a.recycle()
         }
 
+        /**
+         * Content description for talkback functional
+         */
+        fun getContentDescription(context: Context): CharSequence {
+            return when (code) {
+                KEYCODE_SHIFT -> context.getString(R.string.keycode_shift)
+                KEYCODE_MODE_CHANGE -> context.getString(R.string.keycode_mode_change)
+                KEYCODE_ENTER -> context.getString(R.string.keycode_enter)
+                KEYCODE_DELETE -> context.getString(R.string.keycode_delete)
+                KEYCODE_SPACE -> context.getString(R.string.keycode_space)
+                KEYCODE_EMOJI -> context.getString(R.string.emojis)
+                else -> label
+            }
+        }
+
         /** Create an empty key with no attributes.  */
         init {
             height = parent.defaultHeight

app/src/main/kotlin/com/simplemobiletools/keyboard/interfaces/OnKeyboardActionListener.kt

@@ -0,0 +1,41 @@
+package com.simplemobiletools.keyboard.interfaces
+
+interface OnKeyboardActionListener {
+    /**
+     * Called when the user presses a key. This is sent before the [.onKey] is called. For keys that repeat, this is only called once.
+     * @param primaryCode the unicode of the key being pressed. If the touch is not on a valid key, the value will be zero.
+     */
+    fun onPress(primaryCode: Int)
+
+    /**
+     * Send a key press to the listener.
+     * @param code this is the key that was pressed
+     */
+    fun onKey(code: Int)
+
+    /**
+     * Called when the finger has been lifted after pressing a key
+     */
+    fun onActionUp()
+
+    /**
+     * Called when the user long presses Space and moves to the left
+     */
+    fun moveCursorLeft()
+
+    /**
+     * Called when the user long presses Space and moves to the right
+     */
+    fun moveCursorRight()
+
+    /**
+     * Sends a sequence of characters to the listener.
+     * @param text the string to be displayed.
+     */
+    fun onText(text: String)
+
+    /**
+     * Called to force the KeyboardView to reload the keyboard
+     */
+    fun reloadKeyboard()
+}

app/src/main/kotlin/com/simplemobiletools/keyboard/services/SimpleKeyboardIME.kt

@@ -15,11 +15,12 @@ import com.simplemobiletools.commons.extensions.getSharedPrefs
 import com.simplemobiletools.keyboard.R
 import com.simplemobiletools.keyboard.extensions.config
 import com.simplemobiletools.keyboard.helpers.*
+import com.simplemobiletools.keyboard.interfaces.OnKeyboardActionListener
 import com.simplemobiletools.keyboard.views.MyKeyboardView
 import kotlinx.android.synthetic.main.keyboard_view_keyboard.view.*
 
 // based on https://www.androidauthority.com/lets-build-custom-keyboard-android-832362/
-class SimpleKeyboardIME : InputMethodService(), MyKeyboardView.OnKeyboardActionListener, SharedPreferences.OnSharedPreferenceChangeListener {
+class SimpleKeyboardIME : InputMethodService(), OnKeyboardActionListener, SharedPreferences.OnSharedPreferenceChangeListener {
     private var SHIFT_PERM_TOGGLE_SPEED = 500   // how quickly do we have to doubletap shift to enable permanent caps lock
     private val KEYBOARD_LETTERS = 0
     private val KEYBOARD_SYMBOLS = 1

app/src/main/kotlin/com/simplemobiletools/keyboard/views/MyKeyboardView.kt

@@ -16,14 +16,13 @@ import android.os.Message
 import android.util.AttributeSet
 import android.util.TypedValue
 import android.view.*
-import android.view.accessibility.AccessibilityEvent
-import android.view.accessibility.AccessibilityManager
 import android.view.animation.AccelerateInterpolator
 import android.view.inputmethod.EditorInfo
 import android.widget.PopupWindow
 import android.widget.TextView
 import androidx.core.animation.doOnEnd
 import androidx.core.animation.doOnStart
+import androidx.core.view.ViewCompat
 import androidx.emoji2.text.EmojiCompat
 import androidx.emoji2.text.EmojiCompat.EMOJI_SUPPORTED
 import com.simplemobiletools.commons.extensions.*
@@ -43,6 +42,7 @@ import com.simplemobiletools.keyboard.helpers.MyKeyboard.Companion.KEYCODE_ENTER
 import com.simplemobiletools.keyboard.helpers.MyKeyboard.Companion.KEYCODE_MODE_CHANGE
 import com.simplemobiletools.keyboard.helpers.MyKeyboard.Companion.KEYCODE_SHIFT
 import com.simplemobiletools.keyboard.helpers.MyKeyboard.Companion.KEYCODE_SPACE
+import com.simplemobiletools.keyboard.interfaces.OnKeyboardActionListener
 import com.simplemobiletools.keyboard.interfaces.RefreshClipsListener
 import com.simplemobiletools.keyboard.models.Clip
 import com.simplemobiletools.keyboard.models.ClipsSectionLabel
@@ -52,49 +52,18 @@ import kotlinx.android.synthetic.main.keyboard_view_keyboard.view.*
 import java.util.*
 
 @SuppressLint("UseCompatLoadingForDrawables", "ClickableViewAccessibility")
-class MyKeyboardView @JvmOverloads constructor(context: Context, attrs: AttributeSet?, defStyleRes: Int = 0) :
-    View(context, attrs, defStyleRes) {
-
-    interface OnKeyboardActionListener {
-        /**
-         * Called when the user presses a key. This is sent before the [.onKey] is called. For keys that repeat, this is only called once.
-         * @param primaryCode the unicode of the key being pressed. If the touch is not on a valid key, the value will be zero.
-         */
-        fun onPress(primaryCode: Int)
-
-        /**
-         * Send a key press to the listener.
-         * @param code this is the key that was pressed
-         */
-        fun onKey(code: Int)
-
-        /**
-         * Called when the finger has been lifted after pressing a key
-         */
-        fun onActionUp()
-
-        /**
-         * Called when the user long presses Space and moves to the left
-         */
-        fun moveCursorLeft()
-
-        /**
-         * Called when the user long presses Space and moves to the right
-         */
-        fun moveCursorRight()
-
-        /**
-         * Sends a sequence of characters to the listener.
-         * @param text the string to be displayed.
-         */
-        fun onText(text: String)
-
-        /**
-         * Called to force the KeyboardView to reload the keyboard
-         */
-        fun reloadKeyboard()
+class MyKeyboardView @JvmOverloads constructor(context: Context, attrs: AttributeSet?, defStyleRes: Int = 0) : View(context, attrs, defStyleRes) {
+
+    override fun dispatchHoverEvent(event: MotionEvent): Boolean {
+        return if (accessHelper?.dispatchHoverEvent(event) == true) {
+            true
+        } else {
+            super.dispatchHoverEvent(event)
+        }
     }
 
+    private var accessHelper: AccessHelper? = null
+
     private var mKeyboard: MyKeyboard? = null
     private var mCurrentKeyIndex: Int = NOT_A_KEY
 
@@ -184,9 +153,6 @@ class MyKeyboardView @JvmOverloads constructor(context: Context, attrs: Attribut
     /** The canvas for the above mutable keyboard bitmap  */
     private var mCanvas: Canvas? = null
 
-    /** The accessibility manager for accessibility support  */
-    private val mAccessibilityManager: AccessibilityManager
-
     private var mHandler: Handler? = null
 
     companion object {
@@ -245,7 +211,6 @@ class MyKeyboardView @JvmOverloads constructor(context: Context, attrs: Attribut
         mPaint.textAlign = Align.CENTER
         mPaint.alpha = 255
         mMiniKeyboardCache = HashMap()
-        mAccessibilityManager = (context.getSystemService(Context.ACCESSIBILITY_SERVICE) as AccessibilityManager)
         mPopupMaxMoveDistance = resources.getDimension(R.dimen.popup_max_move_distance)
         mTopSmallNumberSize = resources.getDimension(R.dimen.small_text_size)
         mTopSmallNumberMarginWidth = resources.getDimension(R.dimen.top_small_number_margin_width)
@@ -301,6 +266,10 @@ class MyKeyboardView @JvmOverloads constructor(context: Context, attrs: Attribut
         invalidateAllKeys()
         computeProximityThreshold(keyboard)
         mMiniKeyboardCache.clear()
+
+        accessHelper = AccessHelper(this, mKeyboard?.mKeys.orEmpty())
+        ViewCompat.setAccessibilityDelegate(this, accessHelper)
+
         // Not really necessary to do every time, but will free up views
         // Switching to a different keyboard should abort any pending keys so that the key up
         // doesn't get delivered to the old or new keyboard
@@ -479,7 +448,7 @@ class MyKeyboardView @JvmOverloads constructor(context: Context, attrs: Attribut
 
     private fun adjustCase(label: CharSequence): CharSequence? {
         var newLabel: CharSequence? = label
-        if (newLabel != null && newLabel.isNotEmpty() && mKeyboard!!.mShiftState != ShiftState.OFF && newLabel.length < 3 && Character.isLowerCase(newLabel[0])) {
+        if (!newLabel.isNullOrEmpty() && mKeyboard!!.mShiftState != ShiftState.OFF && newLabel.length < 3 && Character.isLowerCase(newLabel[0])) {
             newLabel = newLabel.toString().uppercase(Locale.getDefault())
         }
         return newLabel
@@ -644,10 +613,7 @@ class MyKeyboardView @JvmOverloads constructor(context: Context, attrs: Attribut
                     val secondaryIconBottom = secondaryIconTop + secondaryIconHeight
 
                     secondaryIcon.setBounds(
-                        secondaryIconLeft,
-                        secondaryIconTop,
-                        secondaryIconRight,
-                        secondaryIconBottom
+                        secondaryIconLeft, secondaryIconTop, secondaryIconRight, secondaryIconBottom
                     )
                     secondaryIcon.draw(canvas)
 
@@ -833,29 +799,6 @@ class MyKeyboardView @JvmOverloads constructor(context: Context, attrs: Attribut
         val oldKeyIndex = mCurrentKeyIndex
         val previewPopup = mPreviewPopup
         mCurrentKeyIndex = keyIndex
-        // Release the old key and press the new key
-        val keys = mKeys
-        if (oldKeyIndex != mCurrentKeyIndex) {
-            if (oldKeyIndex != NOT_A_KEY && keys.size > oldKeyIndex) {
-                val oldKey = keys[oldKeyIndex]
-                oldKey.pressed = false
-                invalidateKey(oldKeyIndex)
-                val keyCode = oldKey.code
-                sendAccessibilityEventForUnicodeCharacter(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED, keyCode)
-            }
-
-            if (mCurrentKeyIndex != NOT_A_KEY && keys.size > mCurrentKeyIndex) {
-                val newKey = keys[mCurrentKeyIndex]
-
-                val code = newKey.code
-                if (context.config.showKeyBorders || (code == KEYCODE_SHIFT || code == KEYCODE_MODE_CHANGE || code == KEYCODE_DELETE || code == KEYCODE_ENTER || code == KEYCODE_SPACE)) {
-                    newKey.pressed = true
-                }
-
-                invalidateKey(mCurrentKeyIndex)
-                sendAccessibilityEventForUnicodeCharacter(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED, code)
-            }
-        }
 
         if (!context.config.showPopupOnKeypress) {
             return
@@ -866,8 +809,7 @@ class MyKeyboardView @JvmOverloads constructor(context: Context, attrs: Attribut
             if (previewPopup.isShowing) {
                 if (keyIndex == NOT_A_KEY) {
                     mHandler!!.sendMessageDelayed(
-                        mHandler!!.obtainMessage(MSG_REMOVE_PREVIEW),
-                        DELAY_AFTER_PREVIEW.toLong()
+                        mHandler!!.obtainMessage(MSG_REMOVE_PREVIEW), DELAY_AFTER_PREVIEW.toLong()
                     )
                 }
             }
@@ -960,22 +902,6 @@ class MyKeyboardView @JvmOverloads constructor(context: Context, attrs: Attribut
         }
     }
 
-    private fun sendAccessibilityEventForUnicodeCharacter(eventType: Int, code: Int) {
-        if (mAccessibilityManager.isEnabled) {
-            val event = AccessibilityEvent.obtain(eventType)
-            onInitializeAccessibilityEvent(event)
-            val text: String = when (code) {
-                KEYCODE_DELETE -> context.getString(R.string.keycode_delete)
-                KEYCODE_ENTER -> context.getString(R.string.keycode_enter)
-                KEYCODE_MODE_CHANGE -> context.getString(R.string.keycode_mode_change)
-                KEYCODE_SHIFT -> context.getString(R.string.keycode_shift)
-                else -> code.toChar().toString()
-            }
-            event.text.add(text)
-            mAccessibilityManager.sendAccessibilityEvent(event)
-        }
-    }
-
     /**
      * Requests a redraw of the entire keyboard. Calling [.invalidate] is not sufficient because the keyboard renders the keys to an off-screen buffer and
      * an invalidate() only draws the cached buffer.
@@ -1090,8 +1016,7 @@ class MyKeyboardView @JvmOverloads constructor(context: Context, attrs: Attribut
                     mMiniKeyboard!!.setKeyboard(keyboard)
                     mPopupParent = this
                     mMiniKeyboardContainer!!.measure(
-                        MeasureSpec.makeMeasureSpec(width, MeasureSpec.AT_MOST),
-                        MeasureSpec.makeMeasureSpec(height, MeasureSpec.AT_MOST)
+                        MeasureSpec.makeMeasureSpec(width, MeasureSpec.AT_MOST), MeasureSpec.makeMeasureSpec(height, MeasureSpec.AT_MOST)
                     )
                     mMiniKeyboardCache[popupKey] = mMiniKeyboardContainer
                 } else {

app/src/main/res/layout/keyboard_view_keyboard.xml

@@ -63,7 +63,7 @@
             android:layout_height="@dimen/toolbar_icon_height"
             android:layout_marginEnd="@dimen/medium_margin"
             android:background="?android:attr/selectableItemBackgroundBorderless"
-            android:contentDescription="@string/settings"
+            android:contentDescription="@string/clipboard_pinned"
             android:padding="@dimen/small_margin"
             android:src="@drawable/ic_clipboard_vector"
             app:layout_constraintBottom_toBottomOf="parent"

app/src/main/res/values-ar/strings.xml

@@ -26,6 +26,7 @@
     <string name="keycode_mode_change">تغيير نوع لوحة المفاتيح</string>
     <string name="keycode_shift">Shift</string>
     <string name="keycode_enter">Enter</string>
+    <string name="keycode_space">Spacebar</string>
     <!-- Settings -->
     <string name="show_clipboard_content">إظهار محتوى الحافظة إذا كان متوفرا</string>
     <string name="show_popup">إظهار نافذة منبثقة عند الضغط على المفاتيح</string>

app/src/main/res/values-be/strings.xml

@@ -26,6 +26,7 @@
     <string name="keycode_mode_change">Змяніць тып клавіятуры</string>
     <string name="keycode_shift">Зрух</string>
     <string name="keycode_enter">Увайдзіце</string>
+    <string name="keycode_space">Spacebar</string>
     <!-- Settings -->
     <string name="show_clipboard_content">Паказаць змесціва буфера абмену, калі яно даступна</string>
     <string name="show_popup">Паказваць усплывальнае акно пры націску клавішы</string>

app/src/main/res/values-bg/strings.xml

@@ -26,6 +26,7 @@
     <string name="keycode_mode_change">Промяна на типа клавиатура</string>
     <string name="keycode_shift">Shift</string>
     <string name="keycode_enter">Enter</string>
+    <string name="keycode_space">Spacebar</string>
     <!-- Settings -->
     <string name="show_clipboard_content">Показване на клипборд съдържанието, ако е налично</string>
     <string name="show_popup">Показване на изскачащ прозорец при натискане на клавиш</string>