aboutsummaryrefslogtreecommitdiffstats
path: root/java/src/com/android/inputmethod/accessibility/AccessibleInputMethodServiceProxy.java
blob: 7199550a9a8fb223d871b056ad34722dd504a492 (about) (plain) (blame)
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
/*
 * Copyright (C) 2011 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.inputmethod.accessibility;

import android.content.SharedPreferences;
import android.inputmethodservice.InputMethodService;
import android.os.Looper;
import android.os.Message;
import android.text.TextUtils;
import android.view.inputmethod.ExtractedText;
import android.view.inputmethod.ExtractedTextRequest;

import com.android.inputmethod.latin.R;
import com.android.inputmethod.latin.StaticInnerHandlerWrapper;

public class AccessibleInputMethodServiceProxy implements AccessibleKeyboardActionListener {
    private static final AccessibleInputMethodServiceProxy sInstance =
            new AccessibleInputMethodServiceProxy();

    /*
     * Delay for the handler event that's fired when Accessibility is on and the
     * user hovers outside of any valid keys. This is used to let the user know
     * that if they lift their finger, nothing will be typed.
     */
    private static final long DELAY_NO_HOVER_SELECTION = 250;

    private InputMethodService mInputMethod;

    private AccessibilityHandler mAccessibilityHandler;

    private static class AccessibilityHandler
            extends StaticInnerHandlerWrapper<AccessibleInputMethodServiceProxy> {
        private static final int MSG_NO_HOVER_SELECTION = 0;

        public AccessibilityHandler(AccessibleInputMethodServiceProxy outerInstance,
                Looper looper) {
            super(outerInstance, looper);
        }

        @Override
        public void handleMessage(Message msg) {
            switch (msg.what) {
            case MSG_NO_HOVER_SELECTION:
                getOuterInstance().notifyNoHoverSelection();
                break;
            }
        }

        public void postNoHoverSelection() {
            removeMessages(MSG_NO_HOVER_SELECTION);
            sendEmptyMessageDelayed(MSG_NO_HOVER_SELECTION, DELAY_NO_HOVER_SELECTION);
        }

        public void cancelNoHoverSelection() {
            removeMessages(MSG_NO_HOVER_SELECTION);
        }
    }

    public static void init(InputMethodService inputMethod, SharedPreferences prefs) {
        sInstance.initInternal(inputMethod, prefs);
    }

    public static AccessibleInputMethodServiceProxy getInstance() {
        return sInstance;
    }

    private AccessibleInputMethodServiceProxy() {
        // Not publicly instantiable.
    }

    private void initInternal(InputMethodService inputMethod, SharedPreferences prefs) {
        mInputMethod = inputMethod;
        mAccessibilityHandler = new AccessibilityHandler(this, inputMethod.getMainLooper());
    }

    /**
     * If touch exploration is enabled, cancels the event sent by
     * {@link AccessibleInputMethodServiceProxy#onHoverExit(int)} because the
     * user is currently hovering above a key.
     */
    @Override
    public void onHoverEnter(int primaryCode) {
        mAccessibilityHandler.cancelNoHoverSelection();
    }

    /**
     * If touch exploration is enabled, sends a delayed event to notify the user
     * that they are not currently hovering above a key.
     */
    @Override
    public void onHoverExit(int primaryCode) {
        mAccessibilityHandler.postNoHoverSelection();
    }

    /**
     * When Accessibility is turned on, notifies the user that they are not
     * currently hovering above a key. By default this will speak the currently
     * entered text.
     */
    private void notifyNoHoverSelection() {
        final ExtractedText extracted = mInputMethod.getCurrentInputConnection().getExtractedText(
                new ExtractedTextRequest(), 0);

        if (extracted == null)
            return;

        final CharSequence text;

        if (TextUtils.isEmpty(extracted.text)) {
            text = mInputMethod.getString(R.string.spoken_no_text_entered);
        } else {
            text = mInputMethod.getString(R.string.spoken_current_text_is, extracted.text);
        }

        AccessibilityUtils.getInstance().speak(text);
    }
}