The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 1 | /* |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 2 | * Copyright (C) 2007 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 10 | * Unless required by applicable law or agreed to in writing, software |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 15 | */ |
| 16 | |
| 17 | package android.view.inputmethod; |
| 18 | |
| 19 | import android.os.Bundle; |
Yohei Yukawa | 612cce9 | 2016-02-11 17:47:33 -0800 | [diff] [blame] | 20 | import android.os.Handler; |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 21 | import android.view.KeyEvent; |
| 22 | |
| 23 | /** |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 24 | * <p>Wrapper class for proxying calls to another InputConnection. Subclass and have fun! |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 25 | */ |
| 26 | public class InputConnectionWrapper implements InputConnection { |
Dianne Hackborn | 51bf077 | 2009-03-24 19:11:41 -0700 | [diff] [blame] | 27 | private InputConnection mTarget; |
| 28 | final boolean mMutable; |
Yohei Yukawa | 19a80a1 | 2016-03-14 22:57:37 -0700 | [diff] [blame] | 29 | @InputConnectionInspector.MissingMethodFlags |
| 30 | private int mMissingMethodFlags; |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 31 | |
| 32 | /** |
| 33 | * Initializes a wrapper. |
| 34 | * |
| 35 | * <p><b>Caveat:</b> Although the system can accept {@code (InputConnection) null} in some |
| 36 | * places, you cannot emulate such a behavior by non-null {@link InputConnectionWrapper} that |
| 37 | * has {@code null} in {@code target}.</p> |
| 38 | * @param target the {@link InputConnection} to be proxied. |
| 39 | * @param mutable set {@code true} to protect this object from being reconfigured to target |
| 40 | * another {@link InputConnection}. Note that this is ignored while the target is {@code null}. |
| 41 | */ |
Yohei Yukawa | abc4b8f | 2016-02-29 13:35:59 -0800 | [diff] [blame] | 42 | public InputConnectionWrapper(InputConnection target, boolean mutable) { |
Dianne Hackborn | 51bf077 | 2009-03-24 19:11:41 -0700 | [diff] [blame] | 43 | mMutable = mutable; |
| 44 | mTarget = target; |
Yohei Yukawa | 19a80a1 | 2016-03-14 22:57:37 -0700 | [diff] [blame] | 45 | mMissingMethodFlags = InputConnectionInspector.getMissingMethodFlags(target); |
Dianne Hackborn | 51bf077 | 2009-03-24 19:11:41 -0700 | [diff] [blame] | 46 | } |
| 47 | |
| 48 | /** |
| 49 | * Change the target of the input connection. |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 50 | * |
| 51 | * <p><b>Caveat:</b> Although the system can accept {@code (InputConnection) null} in some |
| 52 | * places, you cannot emulate such a behavior by non-null {@link InputConnectionWrapper} that |
| 53 | * has {@code null} in {@code target}.</p> |
| 54 | * @param target the {@link InputConnection} to be proxied. |
| 55 | * @throws SecurityException when this wrapper has non-null target and is immutable. |
Dianne Hackborn | 51bf077 | 2009-03-24 19:11:41 -0700 | [diff] [blame] | 56 | */ |
Yohei Yukawa | abc4b8f | 2016-02-29 13:35:59 -0800 | [diff] [blame] | 57 | public void setTarget(InputConnection target) { |
Dianne Hackborn | 51bf077 | 2009-03-24 19:11:41 -0700 | [diff] [blame] | 58 | if (mTarget != null && !mMutable) { |
| 59 | throw new SecurityException("not mutable"); |
| 60 | } |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 61 | mTarget = target; |
Yohei Yukawa | 19a80a1 | 2016-03-14 22:57:37 -0700 | [diff] [blame] | 62 | mMissingMethodFlags = InputConnectionInspector.getMissingMethodFlags(target); |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * @hide |
| 67 | */ |
| 68 | @InputConnectionInspector.MissingMethodFlags |
| 69 | public int getMissingMethodFlags() { |
| 70 | return mMissingMethodFlags; |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 71 | } |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 72 | |
| 73 | /** |
| 74 | * {@inheritDoc} |
| 75 | * @throws NullPointerException if the target is {@code null}. |
| 76 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 77 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 78 | public CharSequence getTextBeforeCursor(int n, int flags) { |
| 79 | return mTarget.getTextBeforeCursor(n, flags); |
| 80 | } |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 81 | |
| 82 | /** |
| 83 | * {@inheritDoc} |
| 84 | * @throws NullPointerException if the target is {@code null}. |
| 85 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 86 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 87 | public CharSequence getTextAfterCursor(int n, int flags) { |
| 88 | return mTarget.getTextAfterCursor(n, flags); |
| 89 | } |
| 90 | |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 91 | /** |
| 92 | * {@inheritDoc} |
| 93 | * @throws NullPointerException if the target is {@code null}. |
| 94 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 95 | @Override |
Amith Yamasani | a90b7f0 | 2010-08-25 18:27:20 -0700 | [diff] [blame] | 96 | public CharSequence getSelectedText(int flags) { |
| 97 | return mTarget.getSelectedText(flags); |
| 98 | } |
| 99 | |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 100 | /** |
| 101 | * {@inheritDoc} |
| 102 | * @throws NullPointerException if the target is {@code null}. |
| 103 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 104 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 105 | public int getCursorCapsMode(int reqModes) { |
| 106 | return mTarget.getCursorCapsMode(reqModes); |
| 107 | } |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 108 | |
| 109 | /** |
| 110 | * {@inheritDoc} |
| 111 | * @throws NullPointerException if the target is {@code null}. |
| 112 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 113 | @Override |
satok | e3797a1 | 2011-03-22 06:34:48 +0900 | [diff] [blame] | 114 | public ExtractedText getExtractedText(ExtractedTextRequest request, int flags) { |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 115 | return mTarget.getExtractedText(request, flags); |
| 116 | } |
| 117 | |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 118 | /** |
| 119 | * {@inheritDoc} |
| 120 | * @throws NullPointerException if the target is {@code null}. |
| 121 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 122 | @Override |
Yohei Yukawa | c89e22a | 2016-01-13 22:48:14 -0800 | [diff] [blame] | 123 | public boolean deleteSurroundingTextInCodePoints(int beforeLength, int afterLength) { |
| 124 | return mTarget.deleteSurroundingTextInCodePoints(beforeLength, afterLength); |
| 125 | } |
| 126 | |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 127 | /** |
| 128 | * {@inheritDoc} |
| 129 | * @throws NullPointerException if the target is {@code null}. |
| 130 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 131 | @Override |
Fabrice Di Meglio | 0c95dd3 | 2012-01-23 15:06:42 -0800 | [diff] [blame] | 132 | public boolean deleteSurroundingText(int beforeLength, int afterLength) { |
| 133 | return mTarget.deleteSurroundingText(beforeLength, afterLength); |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 134 | } |
| 135 | |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 136 | /** |
| 137 | * {@inheritDoc} |
| 138 | * @throws NullPointerException if the target is {@code null}. |
| 139 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 140 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 141 | public boolean setComposingText(CharSequence text, int newCursorPosition) { |
| 142 | return mTarget.setComposingText(text, newCursorPosition); |
| 143 | } |
| 144 | |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 145 | /** |
| 146 | * {@inheritDoc} |
| 147 | * @throws NullPointerException if the target is {@code null}. |
| 148 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 149 | @Override |
Amith Yamasani | a90b7f0 | 2010-08-25 18:27:20 -0700 | [diff] [blame] | 150 | public boolean setComposingRegion(int start, int end) { |
| 151 | return mTarget.setComposingRegion(start, end); |
| 152 | } |
| 153 | |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 154 | /** |
| 155 | * {@inheritDoc} |
| 156 | * @throws NullPointerException if the target is {@code null}. |
| 157 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 158 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 159 | public boolean finishComposingText() { |
| 160 | return mTarget.finishComposingText(); |
| 161 | } |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 162 | |
| 163 | /** |
| 164 | * {@inheritDoc} |
| 165 | * @throws NullPointerException if the target is {@code null}. |
| 166 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 167 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 168 | public boolean commitText(CharSequence text, int newCursorPosition) { |
| 169 | return mTarget.commitText(text, newCursorPosition); |
| 170 | } |
| 171 | |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 172 | /** |
| 173 | * {@inheritDoc} |
| 174 | * @throws NullPointerException if the target is {@code null}. |
| 175 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 176 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 177 | public boolean commitCompletion(CompletionInfo text) { |
| 178 | return mTarget.commitCompletion(text); |
| 179 | } |
| 180 | |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 181 | /** |
| 182 | * {@inheritDoc} |
| 183 | * @throws NullPointerException if the target is {@code null}. |
| 184 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 185 | @Override |
Gilles Debunne | cf9cf2f | 2010-12-08 17:43:58 -0800 | [diff] [blame] | 186 | public boolean commitCorrection(CorrectionInfo correctionInfo) { |
| 187 | return mTarget.commitCorrection(correctionInfo); |
| 188 | } |
| 189 | |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 190 | /** |
| 191 | * {@inheritDoc} |
| 192 | * @throws NullPointerException if the target is {@code null}. |
| 193 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 194 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 195 | public boolean setSelection(int start, int end) { |
| 196 | return mTarget.setSelection(start, end); |
| 197 | } |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 198 | |
| 199 | /** |
| 200 | * {@inheritDoc} |
| 201 | * @throws NullPointerException if the target is {@code null}. |
| 202 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 203 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 204 | public boolean performEditorAction(int editorAction) { |
| 205 | return mTarget.performEditorAction(editorAction); |
| 206 | } |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 207 | |
| 208 | /** |
| 209 | * {@inheritDoc} |
| 210 | * @throws NullPointerException if the target is {@code null}. |
| 211 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 212 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 213 | public boolean performContextMenuAction(int id) { |
| 214 | return mTarget.performContextMenuAction(id); |
| 215 | } |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 216 | |
| 217 | /** |
| 218 | * {@inheritDoc} |
| 219 | * @throws NullPointerException if the target is {@code null}. |
| 220 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 221 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 222 | public boolean beginBatchEdit() { |
| 223 | return mTarget.beginBatchEdit(); |
| 224 | } |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 225 | |
| 226 | /** |
| 227 | * {@inheritDoc} |
| 228 | * @throws NullPointerException if the target is {@code null}. |
| 229 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 230 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 231 | public boolean endBatchEdit() { |
| 232 | return mTarget.endBatchEdit(); |
| 233 | } |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 234 | |
| 235 | /** |
| 236 | * {@inheritDoc} |
| 237 | * @throws NullPointerException if the target is {@code null}. |
| 238 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 239 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 240 | public boolean sendKeyEvent(KeyEvent event) { |
| 241 | return mTarget.sendKeyEvent(event); |
| 242 | } |
| 243 | |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 244 | /** |
| 245 | * {@inheritDoc} |
| 246 | * @throws NullPointerException if the target is {@code null}. |
| 247 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 248 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 249 | public boolean clearMetaKeyStates(int states) { |
| 250 | return mTarget.clearMetaKeyStates(states); |
| 251 | } |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 252 | |
| 253 | /** |
| 254 | * {@inheritDoc} |
| 255 | * @throws NullPointerException if the target is {@code null}. |
| 256 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 257 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 258 | public boolean reportFullscreenMode(boolean enabled) { |
| 259 | return mTarget.reportFullscreenMode(enabled); |
| 260 | } |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 261 | |
| 262 | /** |
| 263 | * {@inheritDoc} |
| 264 | * @throws NullPointerException if the target is {@code null}. |
| 265 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 266 | @Override |
The Android Open Source Project | b2a3dd8 | 2009-03-09 11:52:12 -0700 | [diff] [blame] | 267 | public boolean performPrivateCommand(String action, Bundle data) { |
| 268 | return mTarget.performPrivateCommand(action, data); |
| 269 | } |
Yohei Yukawa | 0023d0e | 2014-07-11 04:13:03 +0900 | [diff] [blame] | 270 | |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 271 | /** |
| 272 | * {@inheritDoc} |
| 273 | * @throws NullPointerException if the target is {@code null}. |
| 274 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 275 | @Override |
Yohei Yukawa | d8636ea | 2014-09-02 22:03:30 -0700 | [diff] [blame] | 276 | public boolean requestCursorUpdates(int cursorUpdateMode) { |
| 277 | return mTarget.requestCursorUpdates(cursorUpdateMode); |
Yohei Yukawa | 0023d0e | 2014-07-11 04:13:03 +0900 | [diff] [blame] | 278 | } |
Yohei Yukawa | 612cce9 | 2016-02-11 17:47:33 -0800 | [diff] [blame] | 279 | |
Yohei Yukawa | 1d1c21c | 2016-02-29 15:02:41 -0800 | [diff] [blame] | 280 | /** |
| 281 | * {@inheritDoc} |
| 282 | * @throws NullPointerException if the target is {@code null}. |
| 283 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 284 | @Override |
Yohei Yukawa | 612cce9 | 2016-02-11 17:47:33 -0800 | [diff] [blame] | 285 | public Handler getHandler() { |
| 286 | return mTarget.getHandler(); |
| 287 | } |
Yohei Yukawa | 9f9afe52 | 2016-03-30 12:03:51 -0700 | [diff] [blame] | 288 | |
| 289 | /** |
| 290 | * {@inheritDoc} |
| 291 | * @throws NullPointerException if the target is {@code null}. |
| 292 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 293 | @Override |
Yohei Yukawa | 9f9afe52 | 2016-03-30 12:03:51 -0700 | [diff] [blame] | 294 | public void closeConnection() { |
| 295 | mTarget.closeConnection(); |
| 296 | } |
Yohei Yukawa | 152944f | 2016-06-10 19:04:34 -0700 | [diff] [blame] | 297 | |
| 298 | /** |
| 299 | * {@inheritDoc} |
| 300 | * @throws NullPointerException if the target is {@code null}. |
| 301 | */ |
Yohei Yukawa | 7a8c9aa | 2018-01-15 19:43:38 -0800 | [diff] [blame] | 302 | @Override |
Yohei Yukawa | 45700fa | 2016-06-23 17:12:59 -0700 | [diff] [blame] | 303 | public boolean commitContent(InputContentInfo inputContentInfo, int flags, Bundle opts) { |
| 304 | return mTarget.commitContent(inputContentInfo, flags, opts); |
Yohei Yukawa | 152944f | 2016-06-10 19:04:34 -0700 | [diff] [blame] | 305 | } |
Yohei Yukawa | d8636ea | 2014-09-02 22:03:30 -0700 | [diff] [blame] | 306 | } |